MakeBase.gmk revision 1704:2396a16033e1
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 $(MKDIR) -p $(BUILDTIMESDIR) 90 $(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) 91 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$(strip $1)_human_readable 92endef 93 94# Record ending time and calculate the difference and store it in a 95# easy to read format. Handles builds that cross midnight. Expects 96# that a build will never take 24 hours or more. 97define RecordEndTime 98 $(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) 99 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)_human_readable 100 $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$(strip $1)` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$(strip $1)` $1 | \ 101 $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ 102 M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ 103 > $(BUILDTIMESDIR)/build_time_diff_$(strip $1) 104endef 105 106# Hook to be called when starting to execute a top-level target 107define TargetEnter 108 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 109 $(call RecordStartTime,$(patsubst %-only,%,$@)) 110endef 111 112# Hook to be called when finish executing a top-level target 113define TargetExit 114 $(call RecordEndTime,$(patsubst %-only,%,$@)) 115 $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ 116 "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" 117endef 118 119################################################################################ 120# This macro translates $ into \$ to protect the $ from expansion in the shell. 121# To make this macro resilient against already escaped strings, first remove 122# any present escapes before escaping so that no double escapes are added. 123EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 124 125################################################################################ 126# This macro translates $ into $$ to protect the string from make itself. 127DoubleDollar = $(subst $$,$$$$,$(strip $1)) 128 129################################################################################ 130# ListPathsSafely can be used to print command parameters to a file. This is 131# typically done if the command line lenght risk being too long for the 132# OS/shell. In later make versions, the file function can be used for this 133# purpose. For earlier versions, a more complex implementation is provided. 134# 135# The function ListPathsSafely can be called either directly or, more commonly 136# from a recipe line. If called from a recipe, it will be executed in the 137# evaluation phase of that recipe, which means that it will write to the file 138# before any other line in the recipe has been run. 139ifeq ($(HAS_FILE_FUNCTION), true) 140 # Param 1 - Name of variable containing paths/arguments to output 141 # Param 2 - File to print to 142 # Param 3 - Set to true to append to file instead of overwriting 143 define ListPathsSafely 144 $$(call MakeDir, $$(dir $$(strip $2))) 145 $$(file $$(if $$(filter true, $$(strip $3)),>>,>) \ 146 $$(strip $2),$$(subst $$(SPACE),$$(NEWLINE),$$(strip $$($$(strip $1))))) 147 endef 148 149else # HAS_FILE_FUNCTION 150 151 $(eval compress_paths = \ 152 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-pre-compress.incl))) 153 compress_paths += \ 154$(subst $(SRC_ROOT),X97,\ 155$(subst $(OUTPUT_ROOT),X98,\ 156$(subst X,X00,\ 157 $(subst $(SPACE),\n,$(strip $1))))) 158 $(eval compress_paths += \ 159 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-post-compress.incl))) 160 161 decompress_paths=$(SED) -f $(SRC_ROOT)/make/common/support/ListPathsSafely-uncompress.sed \ 162 -e 's|X99|\\n|g' \ 163 -e 's|X98|$(OUTPUT_ROOT)|g' -e 's|X97|$(SRC_ROOT)|g' \ 164 -e 's|X00|X|g' 165 166 ListPathsSafely_IfPrintf = \ 167 $(if $(word $3,$($(strip $1))), \ 168 $(shell $(PRINTF) -- "$(strip $(call EscapeDollar, \ 169 $(call compress_paths, $(wordlist $3,$4,$($(strip $1))))))\n" \ 170 | $(decompress_paths) >> $2)) 171 172 # Param 1 - Name of variable containing paths/arguments to output 173 # Param 2 - File to print to 174 # Param 3 - Set to true to append to file instead of overwriting 175define ListPathsSafely 176 ifneq (,$$(word 10001,$$($1))) 177 $$(error Cannot list safely more than 10000 paths. $1 has $$(words $$($1)) paths!) 178 endif 179 $$(call MakeDir, $$(dir $2)) 180 ifneq ($$(strip $3), true) 181 $$(shell $(RM) $$(strip $2)) 182 endif 183 184 $$(call ListPathsSafely_IfPrintf,$1,$2,1,250) 185 $$(call ListPathsSafely_IfPrintf,$1,$2,251,500) 186 $$(call ListPathsSafely_IfPrintf,$1,$2,501,750) 187 $$(call ListPathsSafely_IfPrintf,$1,$2,751,1000) 188 189 $$(call ListPathsSafely_IfPrintf,$1,$2,1001,1250) 190 $$(call ListPathsSafely_IfPrintf,$1,$2,1251,1500) 191 $$(call ListPathsSafely_IfPrintf,$1,$2,1501,1750) 192 $$(call ListPathsSafely_IfPrintf,$1,$2,1751,2000) 193 194 $$(call ListPathsSafely_IfPrintf,$1,$2,2001,2250) 195 $$(call ListPathsSafely_IfPrintf,$1,$2,2251,2500) 196 $$(call ListPathsSafely_IfPrintf,$1,$2,2501,2750) 197 $$(call ListPathsSafely_IfPrintf,$1,$2,2751,3000) 198 199 $$(call ListPathsSafely_IfPrintf,$1,$2,3001,3250) 200 $$(call ListPathsSafely_IfPrintf,$1,$2,3251,3500) 201 $$(call ListPathsSafely_IfPrintf,$1,$2,3501,3750) 202 $$(call ListPathsSafely_IfPrintf,$1,$2,3751,4000) 203 204 $$(call ListPathsSafely_IfPrintf,$1,$2,4001,4250) 205 $$(call ListPathsSafely_IfPrintf,$1,$2,4251,4500) 206 $$(call ListPathsSafely_IfPrintf,$1,$2,4501,4750) 207 $$(call ListPathsSafely_IfPrintf,$1,$2,4751,5000) 208 209 $$(call ListPathsSafely_IfPrintf,$1,$2,5001,5250) 210 $$(call ListPathsSafely_IfPrintf,$1,$2,5251,5500) 211 $$(call ListPathsSafely_IfPrintf,$1,$2,5501,5750) 212 $$(call ListPathsSafely_IfPrintf,$1,$2,5751,6000) 213 214 $$(call ListPathsSafely_IfPrintf,$1,$2,6001,6250) 215 $$(call ListPathsSafely_IfPrintf,$1,$2,6251,6500) 216 $$(call ListPathsSafely_IfPrintf,$1,$2,6501,6750) 217 $$(call ListPathsSafely_IfPrintf,$1,$2,6751,7000) 218 219 $$(call ListPathsSafely_IfPrintf,$1,$2,7001,7250) 220 $$(call ListPathsSafely_IfPrintf,$1,$2,7251,7500) 221 $$(call ListPathsSafely_IfPrintf,$1,$2,7501,7750) 222 $$(call ListPathsSafely_IfPrintf,$1,$2,7751,8000) 223 224 $$(call ListPathsSafely_IfPrintf,$1,$2,8001,8250) 225 $$(call ListPathsSafely_IfPrintf,$1,$2,8251,8500) 226 $$(call ListPathsSafely_IfPrintf,$1,$2,8501,8750) 227 $$(call ListPathsSafely_IfPrintf,$1,$2,8751,9000) 228 229 $$(call ListPathsSafely_IfPrintf,$1,$2,9001,9250) 230 $$(call ListPathsSafely_IfPrintf,$1,$2,9251,9500) 231 $$(call ListPathsSafely_IfPrintf,$1,$2,9501,9750) 232 $$(call ListPathsSafely_IfPrintf,$1,$2,9751,10000) 233endef 234endif # HAS_FILE_FUNCTION 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 jdk/make/closed/bundles.gmk 268define CreateHgTip 269 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \ 270 $(ECHO) $1/$(HGTIP_FILENAME) 271endef 272 273define SetupLogging 274 ifeq ($$(LOG_LEVEL), trace) 275 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 276 # For each target executed, will print 277 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 278 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 279 # (and causing a crash on Cygwin). 280 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 281 # Only use time if it's GNU time which supports format and output file. 282 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 283 SHELL := $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 284 endif 285 # Never remove warning messages; this is just for completeness 286 LOG_WARN := 287 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 288 LOG_INFO := 289 else 290 LOG_INFO := > /dev/null 291 endif 292 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 293 LOG_DEBUG := 294 else 295 LOG_DEBUG := > /dev/null 296 endif 297 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 298 LOG_TRACE := 299 else 300 LOG_TRACE := > /dev/null 301 endif 302endef 303 304# Make sure logging is setup for everyone that includes MakeBase.gmk. 305$(eval $(call SetupLogging)) 306 307################################################################################ 308# Creates a sequence of increasing numbers (inclusive). 309# Param 1 - starting number 310# Param 2 - ending number 311sequence = \ 312 $(wordlist $1, $2, $(strip \ 313 $(eval SEQUENCE_COUNT :=) \ 314 $(call _sequence-do,$(strip $2)))) 315 316_sequence-do = \ 317 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 318 $(eval SEQUENCE_COUNT += .) \ 319 $(words $(SEQUENCE_COUNT)) \ 320 $(call _sequence-do,$1)) 321 322################################################################################ 323 324MAX_PARAMS := 30 325PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 326 327# Template for creating a macro taking named parameters. To use it, assign the 328# template to a variable with the name you want for your macro, using '=' 329# assignment. Then define a macro body with the suffix "Body". The Body macro 330# should take 1 parameter which should be a unique string for that invocation 331# of the macro. 332# Ex: 333# SetupFoo = $(NamedParamsMacroTemplate) 334# define SetupFooBody 335# # do something 336# # access parameters as $$($1_BAR) 337# endef 338# Call it like this 339# $(eval $(call SetupFoo, BUILD_SOMETHING, \ 340# BAR := some parameter value, \ 341# )) 342define NamedParamsMacroTemplate 343 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 344 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 345 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 346 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 347 $(strip $1)_$(strip $($i)))$(NEWLINE)) 348 # Debug print all named parameter names and values 349 $(if $(findstring $(LOG_LEVEL),debug trace), \ 350 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 351 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 352 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 353 354 $(if $(DEBUG_$(strip $1)), 355 $(info -------- <<< Begin expansion of $(strip $1)) \ 356 $(info $(call $(0)Body,$(strip $1))) \ 357 $(info -------- >>> End expansion of $(strip $1)) \ 358 ) 359 360 $(call $(0)Body,$(strip $1)) 361endef 362 363################################################################################ 364# Make directory without forking mkdir if not needed 365MakeDir = \ 366 $(strip $(if $(subst $(wildcard $1 $2 $3 $4 $5 $6 $7 $8 $9),,$(strip $1 $2 $3 $4 $5 $6 $7 $8 $9)),\ 367 $(shell $(MKDIR) -p $1 $2 $3 $4 $5 $6 $7 $8 $9))) 368 369################################################################################ 370# Assign a variable only if it is empty 371# Param 1 - Variable to assign 372# Param 2 - Value to assign 373SetIfEmpty = \ 374 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 375 376################################################################################ 377 378ifeq ($(OPENJDK_TARGET_OS),solaris) 379 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 380 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 381 # name of the target file differs from the source file, rename after copy. 382 # If the source and target parent directories are the same, recursive copy doesn't work 383 # so we fall back on regular copy, which isn't preserving symlinks. 384 define install-file 385 $(MKDIR) -p '$(@D)' 386 $(RM) '$@' 387 if [ "$(@D)" != "$(<D)" ]; then \ 388 $(CP) -f -r -P '$<' '$(@D)'; \ 389 if [ "$(@F)" != "$(<F)" ]; then \ 390 $(MV) '$(@D)/$(<F)' '$@'; \ 391 fi; \ 392 else \ 393 if [ -L '$<' ]; then \ 394 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 395 exit 1; \ 396 fi; \ 397 $(CP) -f '$<' '$@'; \ 398 fi 399 endef 400else ifeq ($(OPENJDK_TARGET_OS),macosx) 401 # On mac, extended attributes sometimes creep into the source files, which may later 402 # cause the creation of ._* files which confuses testing. Clear these with xattr if 403 # set. Some files get their write permissions removed after being copied to the 404 # output dir. When these are copied again to images, xattr would fail. By only clearing 405 # attributes when they are present, failing on this is avoided. 406 define install-file 407 $(MKDIR) -p '$(@D)' 408 $(CP) -fRP '$<' '$@' 409 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 410 endef 411else 412 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 413 # significantly. 414 define install-file 415 $(MKDIR) -p '$(@D)' && $(CP) -fP '$<' '$@' 416 endef 417endif 418 419################################################################################ 420# Filter out duplicate sub strings while preserving order. Keeps the first occurance. 421uniq = \ 422 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 423 424# Returns all whitespace-separated words in $2 where at least one of the 425# whitespace-separated words in $1 is a substring. 426containing = \ 427 $(strip \ 428 $(foreach v,$(strip $2),\ 429 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 430 431# Returns all whitespace-separated words in $2 where none of the 432# whitespace-separated words in $1 is a substring. 433not-containing = \ 434 $(strip $(filter-out $(call containing,$1,$2),$2)) 435 436# Return a list of all string elements that are duplicated in $1. 437dups = \ 438 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 439 $(words $(filter $v, $1))), $v))) 440 441# String equals 442equals = \ 443 $(and $(findstring $(strip $1),$(strip $2)),\ 444 $(findstring $(strip $2),$(strip $1))) 445 446# Remove a whole list of prefixes 447# $1 - List of prefixes 448# $2 - List of elements to process 449remove-prefixes = \ 450 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 451 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 452 453################################################################################ 454 455ifneq ($(DISABLE_CACHE_FIND), true) 456 # In Cygwin, finds are very costly, both because of expensive forks and because 457 # of bad file system caching. Find is used extensively in $(shell) commands to 458 # find source files. This makes rerunning make with no or few changes rather 459 # expensive. To speed this up, these two macros are used to cache the results 460 # of simple find commands for reuse. 461 # 462 # Runs a find and stores both the directories where it was run and the results. 463 # This macro can be called multiple times to add to the cache. Only finds files 464 # with no filters. 465 # 466 # Needs to be called with $(eval ) 467 # 468 # Even if the performance benifit is negligible on other platforms, keep the 469 # functionality active unless explicitly disabled to exercise it more. 470 # 471 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 472 FIND_CACHE_DIRS := 473 # Param 1 - Dirs to find in 474 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 475 define FillCacheFind 476 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 477 # since filter out will then return empty. 478 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 479 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 480 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 481 # Remove any trailing slash from dirs in the cache dir list 482 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 483 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 484 endif 485 endef 486 487 # Mimics find by looking in the cache if all of the directories have been cached. 488 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 489 # cache is deactivated. 490 # 491 # $1 can be either a directory or a file. If it's a directory, make 492 # sure we have exactly one trailing slash before the wildcard. 493 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 494 # 495 # Param 1 - Dirs to find in 496 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 497 define CacheFind 498 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 499 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 500 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 501 endef 502 503else 504 # If CacheFind is disabled, just run the find command. 505 # Param 1 - Dirs to find in 506 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 507 define CacheFind 508 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 509 endef 510endif 511 512################################################################################ 513 514define AddFileToCopy 515 # Helper macro for SetupCopyFiles 516 # 1 : Source file 517 # 2 : Dest file 518 # 3 : Variable to add targets to 519 # 4 : Macro to call for copy operation 520 $2: $1 521 $(ECHO) $(LOG_INFO) Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@) 522 $$($$(strip $4)) 523 524 $3 += $2 525endef 526 527# Returns the value of the first argument 528identity = \ 529 $(strip $1) 530 531# Setup make rules for copying files, with an option to do more complex 532# processing instead of copying. 533# 534# Parameter 1 is the name of the rule. This name is used as variable prefix, 535# and the targets generated are listed in a variable by that name. 536# 537# Remaining parameters are named arguments. These include: 538# SRC : Source root dir (defaults to dir of first file) 539# DEST : Dest root dir 540# FILES : List of files to copy with absolute paths, or path relative to SRC. 541# Must be in SRC. 542# FLATTEN : Set to flatten the directory structure in the DEST dir. 543# MACRO : Optionally override the default macro used for making the copy. 544# Default is 'install-file' 545# NAME_MACRO : Optionally supply a macro that rewrites the target file name 546# based on the source file name 547SetupCopyFiles = $(NamedParamsMacroTemplate) 548define SetupCopyFilesBody 549 550 ifeq ($$($1_MACRO), ) 551 $1_MACRO := install-file 552 endif 553 554 # Default SRC to the dir of the first file. 555 ifeq ($$($1_SRC), ) 556 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 557 endif 558 559 ifeq ($$($1_NAME_MACRO), ) 560 $1_NAME_MACRO := identity 561 endif 562 563 # Remove any trailing slash from SRC 564 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 565 566 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 567 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 568 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \ 569 $1, $$($1_MACRO)))) 570 571endef 572 573################################################################################ 574# ShellQuote 575# 576# Quotes a string with single quotes and replaces single quotes with '\'' so 577# that the contents survives being given to the shell. 578 579ShellQuote = \ 580 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 581 582################################################################################ 583# Write to and read from file 584 585# Param 1 - File to read 586ReadFile = \ 587 $(shell $(CAT) $1) 588 589# Param 1 - Text to write 590# Param 2 - File to write to 591ifeq ($(HAS_FILE_FUNCTION), true) 592 WriteFile = \ 593 $(file >$2,$(strip $1)) 594else 595# Use printf to get consistent behavior on all platforms. 596WriteFile = \ 597 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 598endif 599 600################################################################################ 601# DependOnVariable 602# 603# This macro takes a variable name and puts the value in a file only if the 604# value has changed since last. The name of the file is returned. This can be 605# used to create rule dependencies on make variable values. The following 606# example would get rebuilt if the value of SOME_VAR was changed: 607# 608# path/to/some-file: $(call DependOnVariable, SOME_VAR) 609# echo $(SOME_VAR) > $@ 610# 611# Note that leading and trailing white space in the value is ignored. 612# 613 614# Defines the sub directory structure to store variable value file in 615DependOnVariableDirName = \ 616 $(strip $(subst $(SRC_ROOT)/,,\ 617 $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 618 $(firstword $(MAKEFILE_LIST)), \ 619 $(CURDIR)/$(firstword $(MAKEFILE_LIST))))) 620 621# Defines the name of the file to store variable value in. Generates a name 622# unless parameter 2 is given. 623# Param 1 - Name of variable 624# Param 2 - (optional) name of file to store value in 625DependOnVariableFileName = \ 626 $(strip $(if $(strip $2), $2, \ 627 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 628 629# Does the actual work with parameters stripped. 630# If the file exists AND the contents is the same as the variable, do nothing 631# else print a new file. 632# Always returns the name of the file where the value was printed. 633# Param 1 - Name of variable 634# Param 2 - (optional) name of file to store value in 635DependOnVariableHelper = \ 636 $(strip \ 637 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 638 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 639 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 640 $(if $(findstring $(LOG_LEVEL), trace), \ 641 $(info NewVariable $1: >$(strip $($1))<) \ 642 $(info OldVariable $1: >$(strip $($1_old))<)) \ 643 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \ 644 $(call DependOnVariableFileName, $1, $2))) \ 645 $(call DependOnVariableFileName, $1, $2) \ 646 ) 647 648# Main macro 649# Param 1 - Name of variable 650# Param 2 - (optional) name of file to store value in 651DependOnVariable = \ 652 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 653 654################################################################################ 655# Failure logging support macros. These are supposed to be used by the Setup* 656# compilation macros. 657# 658# LogFailures will run a command and store a copy of output in a specified file. 659# If the command succeeds, the file is deleted, otherwise it is moved to the 660# failure-logs directory. 661# Param 1 - The log file of the failed command 662# Param 2 - A compact but representative name to describe this command 663# Param 3 - Command to run 664LogFailures = \ 665 ( ($(BASH) $(SRC_ROOT)/common/bin/logger.sh $1 $3 && $(RM) $1) || \ 666 (exitcode=$(DOLLAR)$(DOLLAR)? && $(MV) $1 $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(strip $2).log && exit $(DOLLAR)$(DOLLAR)exitcode) ) 667 668################################################################################ 669# Find lib dir for module 670# Param 1 - module name 671ifeq ($(OPENJDK_TARGET_OS_TYPE), unix) 672 FindLibDirForModule = \ 673 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)$(OPENJDK_TARGET_CPU_LIBDIR) 674else 675 FindLibDirForModule = \ 676 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 677endif 678 679################################################################################ 680# Return a string suitable for use after a -classpath option. It will correct and safe to use 681# on all platforms. Arguments are given as space separate classpath entries. 682# param 1 : A space separated list of classpath entries 683# The surrounding strip is needed to keep additional whitespace out 684PathList = \ 685 "$(subst $(SPACE),$(PATH_SEP),$(strip $1))" 686 687################################################################################ 688 689# Hook to include the corresponding custom file, if present. 690$(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 691 692endif # _MAKEBASE_GMK 693