1 # 2 # Copyright (c) 2011, 2016, 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 32 ifndef _MAKEBASE_GMK 33 _MAKEBASE_GMK := 1 34 35 ifeq ($(wildcard $(SPEC)),) 36 $(error MakeBase.gmk needs SPEC set to a proper spec.gmk) 37 endif 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. 51 X:= 52 SPACE:=$(X) $(X) 53 COMMA:=, 54 DOLLAR:=$$ 55 HASH:=\# 56 LEFT_PAREN:=( 57 RIGHT_PAREN:=) 58 SQUOTE:=' 59 #' 60 DQUOTE:=" 61 #" 62 define NEWLINE 63 64 65 endef 66 67 # In GNU Make 4.0 and higher, there is a file function for writing to files. 68 ifeq (4.0, $(firstword $(sort 4.0 $(MAKE_VERSION)))) 69 HAS_FILE_FUNCTION := true 70 endif 71 72 ############################## 73 # Functions 74 ############################## 75 76 ### Debug functions 77 78 # Prints the name and value of a variable 79 PrintVar = \ 80 $(info $(strip $1) >$($(strip $1))<) 81 82 ### Functions for timers 83 84 # Store the build times in this directory. 85 BUILDTIMESDIR=$(OUTPUT_ROOT)/make-support/build-times 86 87 # Record starting time for build of a sub repository. 88 define 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 91 endef 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. 96 define 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) 103 endef 104 105 # Hook to be called when starting to execute a top-level target 106 define TargetEnter 107 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 108 $(call RecordStartTime,$(patsubst %-only,%,$@)) 109 endef 110 111 # Hook to be called when finish executing a top-level target 112 define 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 ' '`" 116 endef 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. 122 EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 123 124 ################################################################################ 125 # This macro translates $ into $$ to protect the string from make itself. 126 DoubleDollar = $(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. 138 ifeq ($(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 148 else # 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 233 endif # 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. 240 HG_VERSION = $(shell $(HG) version 2> /dev/null) 241 HG_DIRECTORY=.hg 242 HGTIP_FILENAME=.hgtip 243 HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO 244 REPO_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 $@, but only if they changed since last time 251 define 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 > $@.tmp 264 $(PRINTF) "\n" >> $@.tmp 265 if [ ! -f $@ ] || [ "`$(CAT) $@`" != "`$(CAT) $@.tmp`" ]; then \ 266 $(MV) $@.tmp $@ ; \ 267 else \ 268 $(RM) $@.tmp ; \ 269 fi 270 endef 271 272 # Create the HGTIP_FILENAME file. Called from closed/make/SourceBundles.gmk 273 define CreateHgTip 274 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \ 275 $(ECHO) $1/$(HGTIP_FILENAME) 276 endef 277 278 ################################################################################ 279 280 define SetupLogging 281 ifeq ($$(LOG_LEVEL), trace) 282 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 283 # For each target executed, will print 284 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 285 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 286 # (and causing a crash on Cygwin). 287 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 288 # Only use time if it's GNU time which supports format and output file. 289 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 290 SHELL = $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 291 endif 292 # The warn level can never be turned off 293 LogWarn = $$(info $$(strip $$1)) 294 LOG_WARN := 295 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 296 LogInfo = $$(info $$(strip $$1)) 297 LOG_INFO := 298 else 299 LogInfo = 300 LOG_INFO := > /dev/null 301 endif 302 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 303 LogDebug = $$(info $$(strip $$1)) 304 LOG_DEBUG := 305 else 306 LogDebug = 307 LOG_DEBUG := > /dev/null 308 endif 309 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 310 LogTrace = $$(info $$(strip $$1)) 311 LOG_TRACE := 312 else 313 LogTrace = 314 LOG_TRACE := > /dev/null 315 endif 316 endef 317 318 # Make sure logging is setup for everyone that includes MakeBase.gmk. 319 $(eval $(call SetupLogging)) 320 321 ################################################################################ 322 # Creates a sequence of increasing numbers (inclusive). 323 # Param 1 - starting number 324 # Param 2 - ending number 325 sequence = \ 326 $(wordlist $1, $2, $(strip \ 327 $(eval SEQUENCE_COUNT :=) \ 328 $(call _sequence-do,$(strip $2)))) 329 330 _sequence-do = \ 331 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 332 $(eval SEQUENCE_COUNT += .) \ 333 $(words $(SEQUENCE_COUNT)) \ 334 $(call _sequence-do,$1)) 335 336 ################################################################################ 337 338 MAX_PARAMS := 35 339 PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 340 341 # Template for creating a macro taking named parameters. To use it, assign the 342 # template to a variable with the name you want for your macro, using '=' 343 # assignment. Then define a macro body with the suffix "Body". The Body macro 344 # should take 1 parameter which should be a unique string for that invocation 345 # of the macro. 346 # Ex: 347 # SetupFoo = $(NamedParamsMacroTemplate) 348 # define SetupFooBody 349 # # do something 350 # # access parameters as $$($1_BAR) 351 # endef 352 # Call it like this 353 # $(eval $(call SetupFoo, BUILD_SOMETHING, \ 354 # BAR := some parameter value, \ 355 # )) 356 define NamedParamsMacroTemplate 357 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 358 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 359 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 360 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 361 $(strip $1)_$(strip $($i)))$(NEWLINE)) 362 # Debug print all named parameter names and values 363 $(if $(findstring $(LOG_LEVEL),debug trace), \ 364 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 365 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 366 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 367 368 $(if $(DEBUG_$(strip $1)), 369 $(info -------- <<< Begin expansion of $(strip $1)) \ 370 $(info $(call $(0)Body,$(strip $1))) \ 371 $(info -------- >>> End expansion of $(strip $1)) \ 372 ) 373 374 $(call $(0)Body,$(strip $1)) 375 endef 376 377 ################################################################################ 378 # Make directory without forking mkdir if not needed 379 # 1: List of directories to create 380 MakeDir = \ 381 $(strip \ 382 $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, $(if $(wildcard $d), , $d)))) \ 383 $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \ 384 ) 385 386 ################################################################################ 387 # Assign a variable only if it is empty 388 # Param 1 - Variable to assign 389 # Param 2 - Value to assign 390 SetIfEmpty = \ 391 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 392 393 ################################################################################ 394 395 ifeq ($(OPENJDK_TARGET_OS),solaris) 396 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 397 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 398 # name of the target file differs from the source file, rename after copy. 399 # If the source and target parent directories are the same, recursive copy doesn't work 400 # so we fall back on regular copy, which isn't preserving symlinks. 401 define install-file 402 $(MKDIR) -p '$(@D)' 403 $(RM) '$@' 404 if [ "$(@D)" != "$(<D)" ]; then \ 405 $(CP) -f -r -P '$<' '$(@D)'; \ 406 if [ "$(@F)" != "$(<F)" ]; then \ 407 $(MV) '$(@D)/$(<F)' '$@'; \ 408 fi; \ 409 else \ 410 if [ -L '$<' ]; then \ 411 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 412 exit 1; \ 413 fi; \ 414 $(CP) -f '$<' '$@'; \ 415 fi 416 endef 417 else ifeq ($(OPENJDK_TARGET_OS),macosx) 418 # On mac, extended attributes sometimes creep into the source files, which may later 419 # cause the creation of ._* files which confuses testing. Clear these with xattr if 420 # set. Some files get their write permissions removed after being copied to the 421 # output dir. When these are copied again to images, xattr would fail. By only clearing 422 # attributes when they are present, failing on this is avoided. 423 define install-file 424 $(MKDIR) -p '$(@D)' 425 $(CP) -fRP '$<' '$@' 426 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 427 endef 428 else 429 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 430 # significantly. 431 define install-file 432 $(call MakeDir, $(@D)) 433 $(CP) -fP '$<' '$@' 434 endef 435 endif 436 437 ################################################################################ 438 # Filter out duplicate sub strings while preserving order. Keeps the first occurance. 439 uniq = \ 440 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 441 442 # Returns all whitespace-separated words in $2 where at least one of the 443 # whitespace-separated words in $1 is a substring. 444 containing = \ 445 $(strip \ 446 $(foreach v,$(strip $2),\ 447 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 448 449 # Returns all whitespace-separated words in $2 where none of the 450 # whitespace-separated words in $1 is a substring. 451 not-containing = \ 452 $(strip $(filter-out $(call containing,$1,$2),$2)) 453 454 # Return a list of all string elements that are duplicated in $1. 455 dups = \ 456 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 457 $(words $(filter $v, $1))), $v))) 458 459 # String equals 460 equals = \ 461 $(and $(findstring $(strip $1),$(strip $2)),\ 462 $(findstring $(strip $2),$(strip $1))) 463 464 # Remove a whole list of prefixes 465 # $1 - List of prefixes 466 # $2 - List of elements to process 467 remove-prefixes = \ 468 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 469 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 470 471 # Convert the string given to upper case, without any $(shell) 472 # Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html 473 uppercase_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 \ 474 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z 475 476 uppercase_internal = \ 477 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \ 478 $(wordlist 2, $(words $1), $1), $2)), $2) 479 480 # Convert a string to upper case. Works only on a-z. 481 # $1 - The string to convert 482 uppercase = \ 483 $(strip \ 484 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \ 485 $(uppercase_result) \ 486 ) 487 488 ################################################################################ 489 490 ifneq ($(DISABLE_CACHE_FIND), true) 491 # In Cygwin, finds are very costly, both because of expensive forks and because 492 # of bad file system caching. Find is used extensively in $(shell) commands to 493 # find source files. This makes rerunning make with no or few changes rather 494 # expensive. To speed this up, these two macros are used to cache the results 495 # of simple find commands for reuse. 496 # 497 # Runs a find and stores both the directories where it was run and the results. 498 # This macro can be called multiple times to add to the cache. Only finds files 499 # with no filters. 500 # 501 # Needs to be called with $(eval ) 502 # 503 # Even if the performance benifit is negligible on other platforms, keep the 504 # functionality active unless explicitly disabled to exercise it more. 505 # 506 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 507 FIND_CACHE_DIRS := 508 # Param 1 - Dirs to find in 509 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 510 define FillCacheFind 511 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 512 # since filter out will then return empty. 513 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 514 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 515 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 516 # Remove any trailing slash from dirs in the cache dir list 517 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 518 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 519 endif 520 endef 521 522 # Mimics find by looking in the cache if all of the directories have been cached. 523 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 524 # cache is deactivated. 525 # 526 # $1 can be either a directory or a file. If it's a directory, make 527 # sure we have exactly one trailing slash before the wildcard. 528 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 529 # 530 # Param 1 - Dirs to find in 531 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 532 define CacheFind 533 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 534 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 535 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 536 endef 537 538 else 539 # If CacheFind is disabled, just run the find command. 540 # Param 1 - Dirs to find in 541 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 542 define CacheFind 543 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 544 endef 545 endif 546 547 ################################################################################ 548 549 define AddFileToCopy 550 # Helper macro for SetupCopyFiles 551 # 1 : Source file 552 # 2 : Dest file 553 # 3 : Variable to add targets to 554 # 4 : Macro to call for copy operation 555 $2: $1 556 $$(call LogInfo, Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@)) 557 $$($$(strip $4)) 558 559 $3 += $2 560 endef 561 562 # Returns the value of the first argument 563 identity = \ 564 $(strip $1) 565 566 # Setup make rules for copying files, with an option to do more complex 567 # processing instead of copying. 568 # 569 # Parameter 1 is the name of the rule. This name is used as variable prefix, 570 # and the targets generated are listed in a variable by that name. 571 # 572 # Remaining parameters are named arguments. These include: 573 # SRC : Source root dir (defaults to dir of first file) 574 # DEST : Dest root dir 575 # FILES : List of files to copy with absolute paths, or path relative to SRC. 576 # Must be in SRC. 577 # FLATTEN : Set to flatten the directory structure in the DEST dir. 578 # MACRO : Optionally override the default macro used for making the copy. 579 # Default is 'install-file' 580 # NAME_MACRO : Optionally supply a macro that rewrites the target file name 581 # based on the source file name 582 SetupCopyFiles = $(NamedParamsMacroTemplate) 583 define SetupCopyFilesBody 584 585 ifeq ($$($1_MACRO), ) 586 $1_MACRO := install-file 587 endif 588 589 # Default SRC to the dir of the first file. 590 ifeq ($$($1_SRC), ) 591 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 592 endif 593 594 ifeq ($$($1_NAME_MACRO), ) 595 $1_NAME_MACRO := identity 596 endif 597 598 # Remove any trailing slash from SRC and DEST 599 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 600 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 601 602 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 603 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 604 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \ 605 $1, $$($1_MACRO)))) 606 607 endef 608 609 ################################################################################ 610 # ShellQuote 611 # 612 # Quotes a string with single quotes and replaces single quotes with '\'' so 613 # that the contents survives being given to the shell. 614 615 ShellQuote = \ 616 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 617 618 ################################################################################ 619 # Write to and read from file 620 621 # Param 1 - File to read 622 ReadFile = \ 623 $(shell $(CAT) $1) 624 625 # Param 1 - Text to write 626 # Param 2 - File to write to 627 ifeq ($(HAS_FILE_FUNCTION), true) 628 WriteFile = \ 629 $(file >$2,$(strip $1)) 630 else 631 # Use printf to get consistent behavior on all platforms. 632 WriteFile = \ 633 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 634 endif 635 636 ################################################################################ 637 # DependOnVariable 638 # 639 # This macro takes a variable name and puts the value in a file only if the 640 # value has changed since last. The name of the file is returned. This can be 641 # used to create rule dependencies on make variable values. The following 642 # example would get rebuilt if the value of SOME_VAR was changed: 643 # 644 # path/to/some-file: $(call DependOnVariable, SOME_VAR) 645 # echo $(SOME_VAR) > $@ 646 # 647 # Note that leading and trailing white space in the value is ignored. 648 # 649 650 # Defines the sub directory structure to store variable value file in 651 DependOnVariableDirName = \ 652 $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \ 653 $(subst $(SRC_ROOT)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 654 $(firstword $(MAKEFILE_LIST)), \ 655 $(CURDIR)/$(firstword $(MAKEFILE_LIST)))))) 656 657 # Defines the name of the file to store variable value in. Generates a name 658 # unless parameter 2 is given. 659 # Param 1 - Name of variable 660 # Param 2 - (optional) name of file to store value in 661 DependOnVariableFileName = \ 662 $(strip $(if $(strip $2), $2, \ 663 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 664 665 # Does the actual work with parameters stripped. 666 # If the file exists AND the contents is the same as the variable, do nothing 667 # else print a new file. 668 # Always returns the name of the file where the value was printed. 669 # Param 1 - Name of variable 670 # Param 2 - (optional) name of file to store value in 671 DependOnVariableHelper = \ 672 $(strip \ 673 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 674 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 675 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 676 $(if $(findstring $(LOG_LEVEL), trace), \ 677 $(info NewVariable $1: >$(strip $($1))<) \ 678 $(info OldVariable $1: >$(strip $($1_old))<)) \ 679 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \ 680 $(call DependOnVariableFileName, $1, $2))) \ 681 $(call DependOnVariableFileName, $1, $2) \ 682 ) 683 684 # Main macro 685 # Param 1 - Name of variable 686 # Param 2 - (optional) name of file to store value in 687 DependOnVariable = \ 688 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 689 690 # LogCmdlines is only intended to be used by ExecuteWithLog 691 ifeq ($(LOG_CMDLINES), true) 692 LogCmdlines = $(info $(strip $1)) 693 else 694 LogCmdlines = 695 endif 696 697 ################################################################################ 698 # ExecuteWithLog will run a command and log the output appropriately. This is 699 # meant to be used by commands that do "real" work, like a compilation. 700 # The output is stored in a specified log file, which is displayed at the end 701 # of the build in case of failure. The command line itself is stored in a file, 702 # and also logged to stdout if the LOG=cmdlines option has been given. 703 # 704 # Param 1 - The path to base the name of the log file / command line file on 705 # Param 2 - The command to run 706 ExecuteWithLog = \ 707 $(call LogCmdlines, Exececuting: [$(strip $2)]) \ 708 $(call WriteFile, $2, $(strip $1).cmdline) \ 709 ( ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \ 710 ( exitcode=$(DOLLAR)? && \ 711 $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(BUILD_OUTPUT)/%,%,$(strip $1))).log && \ 712 exit $(DOLLAR)exitcode ) ) && wait ) 713 714 ################################################################################ 715 # Find lib dir for module 716 # Param 1 - module name 717 ifeq ($(OPENJDK_TARGET_OS_TYPE), unix) 718 FindLibDirForModule = \ 719 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)$(OPENJDK_TARGET_CPU_LIBDIR) 720 else 721 FindLibDirForModule = \ 722 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 723 endif 724 725 ################################################################################ 726 # Return a string suitable for use after a -classpath or -modulepath option. It 727 # will be correct and safe to use on all platforms. Arguments are given as space 728 # separate classpath entries. Safe for multiple nested calls. 729 # param 1 : A space separated list of classpath entries 730 # The surrounding strip is needed to keep additional whitespace out 731 PathList = \ 732 "$(subst $(SPACE),$(PATH_SEP),$(strip $(subst $(DQUOTE),,$1)))" 733 734 ################################################################################ 735 # Check if a specified hotspot variant is being built, or at least one of a 736 # list of variants. Will return 'true' or 'false'. 737 # $1 - the variant to test for 738 check-jvm-variant = \ 739 $(strip \ 740 $(if $(filter-out $(VALID_JVM_VARIANTS), $1), \ 741 $(error Internal error: Invalid variant tested: $1)) \ 742 $(if $(filter $1, $(JVM_VARIANTS)), true, false)) 743 744 ################################################################################ 745 # Converts a space separated list to a comma separated list. 746 # 747 # Replacing double-comma with a single comma is to workaround the issue with 748 # some version of make on windows that doesn't substitute spaces with one comma 749 # properly. 750 CommaList = \ 751 $(strip \ 752 $(subst $(COMMA)$(COMMA),$(COMMA),$(subst $(SPACE),$(COMMA),$(strip $1))) \ 753 ) 754 755 ################################################################################ 756 757 # Hook to include the corresponding custom file, if present. 758 $(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 759 760 endif # _MAKEBASE_GMK