1 # 2 # Copyright (c) 2011, 2018, 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 CORRECT_FUNCTION_IN_RECIPE_EVALUATION := true 71 endif 72 73 ############################## 74 # Functions 75 ############################## 76 77 ### Debug functions 78 79 # Prints the name and value of a variable 80 PrintVar = \ 81 $(info $(strip $1) >$($(strip $1))<) 82 83 ### Functions for timers 84 85 # Store the build times in this directory. 86 BUILDTIMESDIR=$(OUTPUTDIR)/make-support/build-times 87 88 # Record starting time for build of a sub repository. 89 define RecordStartTime 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 92 endef 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. 97 define 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) 104 endef 105 106 # Hook to be called when starting to execute a top-level target 107 define TargetEnter 108 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 109 $(call RecordStartTime,$(patsubst %-only,%,$@)) 110 endef 111 112 # Hook to be called when finish executing a top-level target 113 define 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 ' '`" 117 endef 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. 123 EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 124 125 ################################################################################ 126 # This macro works just like EscapeDollar above, but for #. 127 EscapeHash = $(subst \#,\\\#,$(subst \\\#,\#,$(strip $1))) 128 129 ################################################################################ 130 # This macro translates $ into $$ to protect the string from make itself. 131 DoubleDollar = $(subst $$,$$$$,$(strip $1)) 132 133 ################################################################################ 134 # ListPathsSafely can be used to print command parameters to a file. This is 135 # typically done if the command line lenght risk being too long for the 136 # OS/shell. In later make versions, the file function can be used for this 137 # purpose. For earlier versions, a more complex implementation is provided. 138 # 139 # The function ListPathsSafely can be called either directly or, more commonly 140 # from a recipe line. If called from a recipe, it will be executed in the 141 # evaluation phase of that recipe, which means that it will write to the file 142 # before any other line in the recipe has been run. 143 ifeq ($(HAS_FILE_FUNCTION), true) 144 # Param 1 - Name of variable containing paths/arguments to output 145 # Param 2 - File to print to 146 # Param 3 - Set to true to append to file instead of overwriting 147 define ListPathsSafely 148 $$(call MakeDir, $$(dir $$(strip $2))) 149 $$(file $$(if $$(filter true, $$(strip $3)),>>,>) \ 150 $$(strip $2),$$(subst $$(SPACE),$$(NEWLINE),$$(strip $$($$(strip $1))))) 151 endef 152 153 else # HAS_FILE_FUNCTION = false 154 155 $(eval compress_paths = \ 156 $(strip $(shell $(CAT) $(TOPDIR)/make/common/support/ListPathsSafely-pre-compress.incl))) 157 compress_paths += \ 158 $(subst $(TOPDIR),X97, \ 159 $(subst $(OUTPUTDIR),X98, \ 160 $(subst X,X00, \ 161 $(subst $(SPACE),\n,$(strip $1))))) 162 $(eval compress_paths += \ 163 $(strip $(shell $(CAT) $(TOPDIR)/make/common/support/ListPathsSafely-post-compress.incl))) 164 165 decompress_paths=$(SED) -f $(TOPDIR)/make/common/support/ListPathsSafely-uncompress.sed \ 166 -e 's|X99|\\n|g' \ 167 -e 's|X98|$(OUTPUTDIR)|g' -e 's|X97|$(TOPDIR)|g' \ 168 -e 's|X00|X|g' 169 170 ListPathsSafely_IfPrintf = \ 171 $(if $(word $3,$($(strip $1))), \ 172 $(shell $(PRINTF) -- "$(strip $(call EscapeDollar, \ 173 $(call compress_paths, $(wordlist $3,$4,$($(strip $1))))))\n" \ 174 | $(decompress_paths) >> $2)) 175 176 # Param 1 - Name of variable containing paths/arguments to output 177 # Param 2 - File to print to 178 # Param 3 - Set to true to append to file instead of overwriting 179 define ListPathsSafely 180 ifneq (,$$(word 30001,$$($$(strip $1)))) 181 $$(error Cannot list safely more than 30000 paths. $1 has $$(words $$($$(strip $1))) paths!) 182 endif 183 $$(call MakeDir, $$(dir $2)) 184 ifneq ($$(strip $3), true) 185 $$(shell $(RM) $$(strip $2)) 186 endif 187 188 $$(call ListPathsSafely_IfPrintf,$1,$2,1,250) 189 $$(call ListPathsSafely_IfPrintf,$1,$2,251,500) 190 $$(call ListPathsSafely_IfPrintf,$1,$2,501,750) 191 $$(call ListPathsSafely_IfPrintf,$1,$2,751,1000) 192 193 $$(call ListPathsSafely_IfPrintf,$1,$2,1001,1250) 194 $$(call ListPathsSafely_IfPrintf,$1,$2,1251,1500) 195 $$(call ListPathsSafely_IfPrintf,$1,$2,1501,1750) 196 $$(call ListPathsSafely_IfPrintf,$1,$2,1751,2000) 197 198 $$(call ListPathsSafely_IfPrintf,$1,$2,2001,2250) 199 $$(call ListPathsSafely_IfPrintf,$1,$2,2251,2500) 200 $$(call ListPathsSafely_IfPrintf,$1,$2,2501,2750) 201 $$(call ListPathsSafely_IfPrintf,$1,$2,2751,3000) 202 203 $$(call ListPathsSafely_IfPrintf,$1,$2,3001,3250) 204 $$(call ListPathsSafely_IfPrintf,$1,$2,3251,3500) 205 $$(call ListPathsSafely_IfPrintf,$1,$2,3501,3750) 206 $$(call ListPathsSafely_IfPrintf,$1,$2,3751,4000) 207 208 $$(call ListPathsSafely_IfPrintf,$1,$2,4001,4250) 209 $$(call ListPathsSafely_IfPrintf,$1,$2,4251,4500) 210 $$(call ListPathsSafely_IfPrintf,$1,$2,4501,4750) 211 $$(call ListPathsSafely_IfPrintf,$1,$2,4751,5000) 212 213 $$(call ListPathsSafely_IfPrintf,$1,$2,5001,5250) 214 $$(call ListPathsSafely_IfPrintf,$1,$2,5251,5500) 215 $$(call ListPathsSafely_IfPrintf,$1,$2,5501,5750) 216 $$(call ListPathsSafely_IfPrintf,$1,$2,5751,6000) 217 218 $$(call ListPathsSafely_IfPrintf,$1,$2,6001,6250) 219 $$(call ListPathsSafely_IfPrintf,$1,$2,6251,6500) 220 $$(call ListPathsSafely_IfPrintf,$1,$2,6501,6750) 221 $$(call ListPathsSafely_IfPrintf,$1,$2,6751,7000) 222 223 $$(call ListPathsSafely_IfPrintf,$1,$2,7001,7250) 224 $$(call ListPathsSafely_IfPrintf,$1,$2,7251,7500) 225 $$(call ListPathsSafely_IfPrintf,$1,$2,7501,7750) 226 $$(call ListPathsSafely_IfPrintf,$1,$2,7751,8000) 227 228 $$(call ListPathsSafely_IfPrintf,$1,$2,8001,8250) 229 $$(call ListPathsSafely_IfPrintf,$1,$2,8251,8500) 230 $$(call ListPathsSafely_IfPrintf,$1,$2,8501,8750) 231 $$(call ListPathsSafely_IfPrintf,$1,$2,8751,9000) 232 233 $$(call ListPathsSafely_IfPrintf,$1,$2,9001,9250) 234 $$(call ListPathsSafely_IfPrintf,$1,$2,9251,9500) 235 $$(call ListPathsSafely_IfPrintf,$1,$2,9501,9750) 236 $$(call ListPathsSafely_IfPrintf,$1,$2,9751,10000) 237 238 $$(call ListPathsSafely_IfPrintf,$1,$2,10001,10250) 239 $$(call ListPathsSafely_IfPrintf,$1,$2,10251,10500) 240 $$(call ListPathsSafely_IfPrintf,$1,$2,10501,10750) 241 $$(call ListPathsSafely_IfPrintf,$1,$2,10751,11000) 242 243 $$(call ListPathsSafely_IfPrintf,$1,$2,11001,11250) 244 $$(call ListPathsSafely_IfPrintf,$1,$2,11251,11500) 245 $$(call ListPathsSafely_IfPrintf,$1,$2,11501,11750) 246 $$(call ListPathsSafely_IfPrintf,$1,$2,11751,12000) 247 248 $$(call ListPathsSafely_IfPrintf,$1,$2,12001,12250) 249 $$(call ListPathsSafely_IfPrintf,$1,$2,12251,12500) 250 $$(call ListPathsSafely_IfPrintf,$1,$2,12501,12750) 251 $$(call ListPathsSafely_IfPrintf,$1,$2,12751,13000) 252 253 $$(call ListPathsSafely_IfPrintf,$1,$2,13001,13250) 254 $$(call ListPathsSafely_IfPrintf,$1,$2,13251,13500) 255 $$(call ListPathsSafely_IfPrintf,$1,$2,13501,13750) 256 $$(call ListPathsSafely_IfPrintf,$1,$2,13751,14000) 257 258 $$(call ListPathsSafely_IfPrintf,$1,$2,14001,14250) 259 $$(call ListPathsSafely_IfPrintf,$1,$2,14251,14500) 260 $$(call ListPathsSafely_IfPrintf,$1,$2,14501,14750) 261 $$(call ListPathsSafely_IfPrintf,$1,$2,14751,15000) 262 263 $$(call ListPathsSafely_IfPrintf,$1,$2,15001,15250) 264 $$(call ListPathsSafely_IfPrintf,$1,$2,15251,15500) 265 $$(call ListPathsSafely_IfPrintf,$1,$2,15501,15750) 266 $$(call ListPathsSafely_IfPrintf,$1,$2,15751,16000) 267 268 $$(call ListPathsSafely_IfPrintf,$1,$2,16001,16250) 269 $$(call ListPathsSafely_IfPrintf,$1,$2,16251,16500) 270 $$(call ListPathsSafely_IfPrintf,$1,$2,16501,16750) 271 $$(call ListPathsSafely_IfPrintf,$1,$2,16751,17000) 272 273 $$(call ListPathsSafely_IfPrintf,$1,$2,17001,17250) 274 $$(call ListPathsSafely_IfPrintf,$1,$2,17251,17500) 275 $$(call ListPathsSafely_IfPrintf,$1,$2,17501,17750) 276 $$(call ListPathsSafely_IfPrintf,$1,$2,17751,18000) 277 278 $$(call ListPathsSafely_IfPrintf,$1,$2,18001,18250) 279 $$(call ListPathsSafely_IfPrintf,$1,$2,18251,18500) 280 $$(call ListPathsSafely_IfPrintf,$1,$2,18501,18750) 281 $$(call ListPathsSafely_IfPrintf,$1,$2,18751,19000) 282 283 $$(call ListPathsSafely_IfPrintf,$1,$2,19001,19250) 284 $$(call ListPathsSafely_IfPrintf,$1,$2,19251,19500) 285 $$(call ListPathsSafely_IfPrintf,$1,$2,19501,19750) 286 $$(call ListPathsSafely_IfPrintf,$1,$2,19751,20000) 287 288 $$(call ListPathsSafely_IfPrintf,$1,$2,20001,20250) 289 $$(call ListPathsSafely_IfPrintf,$1,$2,20251,20500) 290 $$(call ListPathsSafely_IfPrintf,$1,$2,20501,20750) 291 $$(call ListPathsSafely_IfPrintf,$1,$2,20751,21000) 292 293 $$(call ListPathsSafely_IfPrintf,$1,$2,21001,21250) 294 $$(call ListPathsSafely_IfPrintf,$1,$2,21251,21500) 295 $$(call ListPathsSafely_IfPrintf,$1,$2,21501,21750) 296 $$(call ListPathsSafely_IfPrintf,$1,$2,21751,22000) 297 298 $$(call ListPathsSafely_IfPrintf,$1,$2,22001,22250) 299 $$(call ListPathsSafely_IfPrintf,$1,$2,22251,22500) 300 $$(call ListPathsSafely_IfPrintf,$1,$2,22501,22750) 301 $$(call ListPathsSafely_IfPrintf,$1,$2,22751,23000) 302 303 $$(call ListPathsSafely_IfPrintf,$1,$2,23001,23250) 304 $$(call ListPathsSafely_IfPrintf,$1,$2,23251,23500) 305 $$(call ListPathsSafely_IfPrintf,$1,$2,23501,23750) 306 $$(call ListPathsSafely_IfPrintf,$1,$2,23751,24000) 307 308 $$(call ListPathsSafely_IfPrintf,$1,$2,24001,24250) 309 $$(call ListPathsSafely_IfPrintf,$1,$2,24251,24500) 310 $$(call ListPathsSafely_IfPrintf,$1,$2,24501,24750) 311 $$(call ListPathsSafely_IfPrintf,$1,$2,24751,25000) 312 313 $$(call ListPathsSafely_IfPrintf,$1,$2,25001,25250) 314 $$(call ListPathsSafely_IfPrintf,$1,$2,25251,25500) 315 $$(call ListPathsSafely_IfPrintf,$1,$2,25501,25750) 316 $$(call ListPathsSafely_IfPrintf,$1,$2,25751,26000) 317 318 $$(call ListPathsSafely_IfPrintf,$1,$2,26001,26250) 319 $$(call ListPathsSafely_IfPrintf,$1,$2,26251,26500) 320 $$(call ListPathsSafely_IfPrintf,$1,$2,26501,26750) 321 $$(call ListPathsSafely_IfPrintf,$1,$2,26751,27000) 322 323 $$(call ListPathsSafely_IfPrintf,$1,$2,27001,27250) 324 $$(call ListPathsSafely_IfPrintf,$1,$2,27251,27500) 325 $$(call ListPathsSafely_IfPrintf,$1,$2,27501,27750) 326 $$(call ListPathsSafely_IfPrintf,$1,$2,27751,28000) 327 328 $$(call ListPathsSafely_IfPrintf,$1,$2,28001,28250) 329 $$(call ListPathsSafely_IfPrintf,$1,$2,28251,28500) 330 $$(call ListPathsSafely_IfPrintf,$1,$2,28501,28750) 331 $$(call ListPathsSafely_IfPrintf,$1,$2,28751,29000) 332 333 $$(call ListPathsSafely_IfPrintf,$1,$2,29001,29250) 334 $$(call ListPathsSafely_IfPrintf,$1,$2,29251,29500) 335 $$(call ListPathsSafely_IfPrintf,$1,$2,29501,29750) 336 $$(call ListPathsSafely_IfPrintf,$1,$2,29751,30000) 337 endef 338 endif # HAS_FILE_FUNCTION 339 340 ################################################################################ 341 342 # A file containing a way to uniquely identify the source code revision that 343 # the build was created from 344 SOURCE_REVISION_TRACKER := $(SUPPORT_OUTPUTDIR)/src-rev/source-revision-tracker 345 346 # Locate all hg repositories included in the forest, as absolute paths 347 FindAllReposAbs = \ 348 $(strip $(sort $(dir $(filter-out $(TOPDIR)/build/%, $(wildcard \ 349 $(addprefix $(TOPDIR)/, .hg */.hg */*/.hg */*/*/.hg */*/*/*/.hg) \ 350 ))))) 351 352 # Locate all hg repositories included in the forest, as relative paths 353 FindAllReposRel = \ 354 $(strip $(subst $(TOPDIR)/,.,$(patsubst $(TOPDIR)/%/, %, $(FindAllReposAbs)))) 355 356 ################################################################################ 357 358 define SetupLogging 359 ifeq ($$(LOG_PROFILE_TIMES_FILE), true) 360 ifeq ($$(IS_GNU_TIME), yes) 361 SHELL := $$(BASH) $$(TOPDIR)/make/scripts/shell-profiler.sh \ 362 gnutime $$(TIME) \ 363 $$(OUTPUTDIR)/build-profile.log $$(SHELL) 364 else ifneq ($$(FLOCK), ) 365 SHELL := $$(BASH) $$(TOPDIR)/make/scripts/shell-profiler.sh \ 366 flock $$(FLOCK) \ 367 $$(OUTPUTDIR)/build-profile.log $$(SHELL) 368 endif 369 endif 370 371 ifeq ($$(LOG_LEVEL), trace) 372 SHELL_NO_RECURSE := $$(SHELL) 373 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 374 # For each target executed, will print 375 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 376 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 377 # (and causing a crash on Cygwin). 378 SHELL = $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(SHELL_NO_RECURSE) -x 379 endif 380 381 # The warn level can never be turned off 382 LogWarn = $$(info $$(strip $$1)) 383 LOG_WARN := 384 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 385 LogInfo = $$(info $$(strip $$1)) 386 LOG_INFO := 387 else 388 LogInfo = 389 LOG_INFO := > /dev/null 390 endif 391 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 392 LogDebug = $$(info $$(strip $$1)) 393 LOG_DEBUG := 394 else 395 LogDebug = 396 LOG_DEBUG := > /dev/null 397 endif 398 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 399 LogTrace = $$(info $$(strip $$1)) 400 LOG_TRACE := 401 else 402 LogTrace = 403 LOG_TRACE := > /dev/null 404 endif 405 endef 406 407 # Make sure logging is setup for everyone that includes MakeBase.gmk. 408 $(eval $(call SetupLogging)) 409 410 ################################################################################ 411 # Creates a sequence of increasing numbers (inclusive). 412 # Param 1 - starting number 413 # Param 2 - ending number 414 sequence = \ 415 $(wordlist $1, $2, $(strip \ 416 $(eval SEQUENCE_COUNT :=) \ 417 $(call _sequence-do,$(strip $2)))) 418 419 _sequence-do = \ 420 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 421 $(eval SEQUENCE_COUNT += .) \ 422 $(words $(SEQUENCE_COUNT)) \ 423 $(call _sequence-do,$1)) 424 425 ################################################################################ 426 427 MAX_PARAMS := 36 428 PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 429 430 # Template for creating a macro taking named parameters. To use it, assign the 431 # template to a variable with the name you want for your macro, using '=' 432 # assignment. Then define a macro body with the suffix "Body". The Body macro 433 # should take 1 parameter which should be a unique string for that invocation 434 # of the macro. 435 # Ex: 436 # SetupFoo = $(NamedParamsMacroTemplate) 437 # define SetupFooBody 438 # # do something 439 # # access parameters as $$($1_BAR) 440 # endef 441 # Call it like this 442 # $(eval $(call SetupFoo, BUILD_SOMETHING, \ 443 # BAR := some parameter value, \ 444 # )) 445 define NamedParamsMacroTemplate 446 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 447 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 448 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 449 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 450 $(strip $1)_$(strip $(call EscapeHash, $(call DoubleDollar, $($i))))$(NEWLINE))) 451 # Debug print all named parameter names and values 452 $(if $(findstring $(LOG_LEVEL),debug trace), \ 453 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 454 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 455 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 456 457 $(if $(DEBUG_$(strip $1)), 458 $(info -------- <<< Begin expansion of $(strip $1)) \ 459 $(info $(call $(0)Body,$(strip $1))) \ 460 $(info -------- >>> End expansion of $(strip $1)) \ 461 ) 462 463 $(call $(0)Body,$(strip $1)) 464 endef 465 466 ################################################################################ 467 # Replace question marks with space in string. This macro needs to be called on 468 # files from CacheFind in case any of them contains space in their file name, 469 # since CacheFind replaces space with ?. 470 # Param 1 - String to replace in 471 DecodeSpace = \ 472 $(subst ?,$(SPACE),$(strip $1)) 473 EncodeSpace = \ 474 $(subst $(SPACE),?,$(strip $1)) 475 476 ################################################################################ 477 # Make directory without forking mkdir if not needed. 478 # 479 # If a directory with an encoded space is provided, the wildcard function 480 # sometimes returns false answers (typically if the dir existed when the 481 # makefile was parsed, but was deleted by a previous rule). In that case, always 482 # call mkdir regardless of what wildcard says. 483 # 484 # 1: List of directories to create 485 MakeDir = \ 486 $(strip \ 487 $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, \ 488 $(if $(findstring ?, $d), '$(call DecodeSpace, $d)', \ 489 $(if $(wildcard $d), , $d) \ 490 ) \ 491 ))) \ 492 $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \ 493 ) 494 495 # Make directory for target file. Should handle spaces in filenames. Just 496 # calling $(call MakeDir $(@D)) will not work if the directory contains a space 497 # and the target file already exists. In that case, the target file will have 498 # its wildcard ? resolved and the $(@D) will evaluate each space separated dir 499 # part on its own. 500 MakeTargetDir = \ 501 $(call MakeDir, $(dir $(call EncodeSpace, $@))) 502 503 ################################################################################ 504 # Assign a variable only if it is empty 505 # Param 1 - Variable to assign 506 # Param 2 - Value to assign 507 SetIfEmpty = \ 508 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 509 510 ################################################################################ 511 # All install-file and related macros automatically call DecodeSpace when needed. 512 513 ifeq ($(OPENJDK_TARGET_OS),solaris) 514 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 515 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 516 # name of the target file differs from the source file, rename after copy. 517 # If the source and target parent directories are the same, recursive copy doesn't work 518 # so we fall back on regular copy, which isn't preserving symlinks. 519 define install-file 520 $(call MakeTargetDir) 521 $(RM) '$(call DecodeSpace, $@)' 522 if [ '$(call DecodeSpace, $(dir $(call EncodeSpace, $@)))' != \ 523 '$(call DecodeSpace, $(dir $(call EncodeSpace, $<)))' ]; then \ 524 $(CP) -f -r -P '$(call DecodeSpace, $<)' \ 525 '$(call DecodeSpace, $(dir $(call EncodeSpace, $@)))'; \ 526 if [ '$(call DecodeSpace, $(notdir $(call EncodeSpace, $@)))' != \ 527 '$(call DecodeSpace, $(notdir $(call EncodeSpace, $(<))))' ]; then \ 528 $(MV) '$(call DecodeSpace, $(dir $(call EncodeSpace, $@))/$(notdir $(call EncodeSpace, $<)))' \ 529 '$(call DecodeSpace, $@)'; \ 530 fi; \ 531 else \ 532 if [ -L '$(call DecodeSpace, $<)' ]; then \ 533 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 534 exit 1; \ 535 fi; \ 536 $(CP) -f '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'; \ 537 fi 538 endef 539 else ifeq ($(OPENJDK_TARGET_OS),macosx) 540 # On mac, extended attributes sometimes creep into the source files, which may later 541 # cause the creation of ._* files which confuses testing. Clear these with xattr if 542 # set. Some files get their write permissions removed after being copied to the 543 # output dir. When these are copied again to images, xattr would fail. By only clearing 544 # attributes when they are present, failing on this is avoided. 545 # 546 # If copying a soft link to a directory, need to delete the target first to avoid 547 # weird errors. 548 define install-file 549 $(call MakeTargetDir) 550 $(RM) '$(call DecodeSpace, $@)' 551 # Work around a weirdness with cp on Macosx. When copying a symlink, if 552 # the target of the link is write protected (e.g. 444), cp will add 553 # write permission for the user on the target file (644). Avoid this by 554 # using ln to create a new link instead. 555 if [ -h '$(call DecodeSpace, $<)' ]; then \ 556 $(LN) -s "`$(READLINK) '$(call DecodeSpace, $<)'`" '$(call DecodeSpace, $@)'; \ 557 else \ 558 $(CP) -fRP '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'; \ 559 fi 560 if [ -n "`$(XATTR) -ls '$(call DecodeSpace, $@)'`" ]; then \ 561 $(XATTR) -cs '$(call DecodeSpace, $@)'; \ 562 fi 563 endef 564 else 565 define install-file 566 $(call MakeTargetDir) 567 $(CP) -fP '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)' 568 endef 569 endif 570 571 # Variant of install file that does not preserve symlinks 572 define install-file-nolink 573 $(call MakeTargetDir) 574 $(CP) -f '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)' 575 endef 576 577 ################################################################################ 578 # Take two paths and return the path of the last common directory. 579 # Ex: /foo/bar/baz, /foo/bar/banan -> /foo/bar 580 # foo/bar/baz, /foo/bar -> <empty> 581 # 582 # The x prefix is used to preserve the presence of the initial slash 583 # 584 # $1 - Path to compare 585 # $2 - Other path to compare 586 FindCommonPathPrefix = \ 587 $(patsubst x%,%,$(subst $(SPACE),/,$(strip \ 588 $(call FindCommonPathPrefixHelper, \ 589 $(subst /,$(SPACE),x$(strip $1)), $(subst /,$(SPACE),x$(strip $2))) \ 590 ))) 591 592 FindCommonPathPrefixHelper = \ 593 $(if $(call equals, $(firstword $1), $(firstword $2)), \ 594 $(firstword $1) \ 595 $(call FindCommonPathPrefixHelper, \ 596 $(wordlist 2, $(words $1), $1), $(wordlist 2, $(words $2), $2) \ 597 ) \ 598 ) 599 600 # Convert a partial path into as many directory levels of ../, removing 601 # leading and following /. 602 # Ex: foo/bar/baz/ -> ../../.. 603 # foo/bar -> ../.. 604 # /foo -> .. 605 DirToDotDot = \ 606 $(subst $(SPACE),/,$(foreach d, $(subst /,$(SPACE),$1),..)) 607 608 # Computes the relative path from a directory to a file 609 # $1 - File to compute the relative path to 610 # $2 - Directory to compute the relative path from 611 RelativePath = \ 612 $(eval $1_prefix := $(call FindCommonPathPrefix, $1, $2)) \ 613 $(eval $1_dotdots := $(call DirToDotDot, $(patsubst $($(strip $1)_prefix)/%, %, $2))) \ 614 $(eval $1_suffix := $(patsubst $($(strip $1)_prefix)/%, %, $1)) \ 615 $($(strip $1)_dotdots)/$($(strip $1)_suffix) 616 617 ################################################################################ 618 # link-file-* works similarly to install-file but creates a symlink instead. 619 # There are two versions, either creating a relative or an absolute link. Be 620 # careful when using this on Windows since the symlink created is only valid in 621 # the unix emulation environment. 622 define link-file-relative 623 $(call MakeTargetDir) 624 $(RM) '$(call DecodeSpace, $@)' 625 $(LN) -s '$(call DecodeSpace, $(call RelativePath, $<, $(@D)))' '$(call DecodeSpace, $@)' 626 endef 627 628 define link-file-absolute 629 $(call MakeTargetDir) 630 $(RM) '$(call DecodeSpace, $@)' 631 $(LN) -s '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)' 632 endef 633 634 ################################################################################ 635 # Filter out duplicate sub strings while preserving order. Keeps the first occurance. 636 uniq = \ 637 $(strip $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))) 638 639 # Returns all whitespace-separated words in $2 where at least one of the 640 # whitespace-separated words in $1 is a substring. 641 containing = \ 642 $(strip \ 643 $(foreach v,$(strip $2),\ 644 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 645 646 # Returns all whitespace-separated words in $2 where none of the 647 # whitespace-separated words in $1 is a substring. 648 not-containing = \ 649 $(strip $(filter-out $(call containing,$1,$2),$2)) 650 651 # Return a list of all string elements that are duplicated in $1. 652 dups = \ 653 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 654 $(words $(filter $v, $1))), $v))) 655 656 # String equals 657 equals = \ 658 $(and $(findstring $(strip $1),$(strip $2)),\ 659 $(findstring $(strip $2),$(strip $1))) 660 661 # Remove a whole list of prefixes 662 # $1 - List of prefixes 663 # $2 - List of elements to process 664 remove-prefixes = \ 665 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 666 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 667 668 # Convert the string given to upper case, without any $(shell) 669 # Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html 670 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 \ 671 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z 672 673 uppercase_internal = \ 674 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \ 675 $(wordlist 2, $(words $1), $1), $2)), $2) 676 677 # Convert a string to upper case. Works only on a-z. 678 # $1 - The string to convert 679 uppercase = \ 680 $(strip \ 681 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \ 682 $(uppercase_result) \ 683 ) 684 685 ################################################################################ 686 687 ifneq ($(DISABLE_CACHE_FIND), true) 688 # In Cygwin, finds are very costly, both because of expensive forks and because 689 # of bad file system caching. Find is used extensively in $(shell) commands to 690 # find source files. This makes rerunning make with no or few changes rather 691 # expensive. To speed this up, these two macros are used to cache the results 692 # of simple find commands for reuse. 693 # 694 # Runs a find and stores both the directories where it was run and the results. 695 # This macro can be called multiple times to add to the cache. Only finds files 696 # with no filters. 697 # 698 # Files containing space will get spaces replaced with ? because GNU Make 699 # cannot handle lists of files with space in them. By using ?, make will match 700 # the wildcard to space in many situations so we don't need to replace back 701 # to space on every use. While not a complete solution it does allow some uses 702 # of CacheFind to function with spaces in file names, including for 703 # SetupCopyFiles. 704 # 705 # Needs to be called with $(eval ) 706 # 707 # Even if the performance benifit is negligible on other platforms, keep the 708 # functionality active unless explicitly disabled to exercise it more. 709 # 710 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 711 FIND_CACHE_DIRS := 712 # Param 1 - Dirs to find in 713 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 714 define FillCacheFind 715 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 716 # since filter out will then return empty. 717 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 718 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 719 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 720 # Remove any trailing slash from dirs in the cache dir list 721 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 722 FIND_CACHE := $$(sort $$(FIND_CACHE) \ 723 $$(shell $(FIND) $$(wildcard $$(FIND_CACHE_NEW_DIRS)) \ 724 \( -type f -o -type l \) $2 | $(TR) ' ' '?')) 725 endif 726 endef 727 728 # Mimics find by looking in the cache if all of the directories have been cached. 729 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 730 # cache is deactivated. 731 # 732 # $1 can be either a directory or a file. If it's a directory, make 733 # sure we have exactly one trailing slash before the wildcard. 734 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 735 # 736 # Param 1 - Dirs to find in 737 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 738 define CacheFind 739 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 740 $(if $(wildcard $1), $(shell $(FIND) $(wildcard $1) \( -type f -o -type l \) $2 \ 741 | $(TR) ' ' '?')), \ 742 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 743 endef 744 745 else 746 # If CacheFind is disabled, just run the find command. 747 # Param 1 - Dirs to find in 748 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 749 define CacheFind 750 $(if $(wildcard $1, \ 751 $(shell $(FIND) $(wildcard $1) \( -type f -o -type l \) $2 | $(TR) ' ' '?') \ 752 ) 753 endef 754 endif 755 756 ################################################################################ 757 758 define AddFileToCopy 759 # Helper macro for SetupCopyFiles 760 # 1 : Source file 761 # 2 : Dest file 762 # 3 : Variable to add targets to 763 # 4 : Macro to call for copy operation 764 # 5 : Action text to log 765 $2: $1 766 $$(call LogInfo, $(strip $5) $$(patsubst $(OUTPUTDIR)/%,%,$$(call DecodeSpace, $$@))) 767 $$($$(strip $4)) 768 769 $3 += $2 770 $3_SOURCES += $1 771 endef 772 773 # Returns the value of the first argument 774 identity = \ 775 $(strip $1) 776 777 # Setup make rules for copying files, with an option to do more complex 778 # processing instead of copying. 779 # 780 # Parameter 1 is the name of the rule. This name is used as variable prefix, 781 # and the targets generated are listed in a variable by that name. 782 # 783 # The list of all source files is returned in $1_SOURCES. 784 # 785 # Remaining parameters are named arguments. These include: 786 # SRC : Source root dir (defaults to dir of first file) 787 # DEST : Dest root dir 788 # FILES : List of files to copy with absolute paths, or path relative to SRC. 789 # Must be in SRC. 790 # FLATTEN : Set to flatten the directory structure in the DEST dir. 791 # MACRO : Optionally override the default macro used for making the copy. 792 # Default is 'install-file' 793 # NAME_MACRO : Optionally supply a macro that rewrites the target file name 794 # based on the source file name 795 # LOG_ACTION : Optionally specify a different action text for log messages 796 SetupCopyFiles = $(NamedParamsMacroTemplate) 797 define SetupCopyFilesBody 798 799 ifeq ($$($1_MACRO), ) 800 $1_MACRO := install-file 801 endif 802 803 # Default SRC to the dir of the first file. 804 ifeq ($$($1_SRC), ) 805 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 806 endif 807 808 ifeq ($$($1_NAME_MACRO), ) 809 $1_NAME_MACRO := identity 810 endif 811 812 ifeq ($$($1_LOG_ACTION), ) 813 $1_LOG_ACTION := Copying 814 endif 815 816 # Remove any trailing slash from SRC and DEST 817 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 818 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 819 820 # Need to wrap arguments in DoubleDollar because of the eval nested inside an 821 # eval macro body. 822 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 823 $$(eval $$(call AddFileToCopy, \ 824 $$(call DoubleDollar, $$($1_SRC)/$$f), \ 825 $$(call DoubleDollar, \ 826 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)) \ 827 ), \ 828 $1, \ 829 $$($1_MACRO), \ 830 $$($1_LOG_ACTION) \ 831 )) \ 832 ) 833 834 endef 835 836 ################################################################################ 837 # Parse a multiple-keyword variable, like FOO="KEYWORD1=val1;KEYWORD2=val2;..." 838 # These will be converted into a series of variables like FOO_KEYWORD1=val1, 839 # FOO_KEYWORD2=val2, etc. Unknown keywords will cause an error. 840 # 841 # Parameter 1 is the name of the rule, and is also the name of the variable. 842 # 843 # Remaining parameters are named arguments. These include: 844 # KEYWORDS A list of valid keywords 845 # STRING_KEYWORDS A list of valid keywords, processed as string. This means 846 # that '%20' will be replaced by ' ' to allow for multi-word strings. 847 # 848 ParseKeywordVariable = $(NamedParamsMacroTemplate) 849 define ParseKeywordVariableBody 850 ifneq ($$($1), ) 851 # To preserve spaces, substitute them with a hopefully unique pattern 852 # before splitting and then re-substitute spaces back. 853 $1_MANGLED := $$(subst $$(SPACE),||||,$$($1)) 854 $$(foreach mangled_part, $$(subst ;, , $$($1_MANGLED)), \ 855 $$(eval mangled_part_eval := $$(call DoubleDollar, $$(mangled_part))) \ 856 $$(eval part := $$$$(subst ||||,$$$$(SPACE),$$$$(mangled_part_eval))) \ 857 $$(eval $1_NO_MATCH := true) \ 858 $$(foreach keyword, $$($1_KEYWORDS), \ 859 $$(eval keyword_eval := $$(call DoubleDollar, $$(keyword))) \ 860 $$(if $$(filter $$(keyword)=%, $$(part)), \ 861 $$(eval $(strip $1)_$$$$(keyword_eval) := $$$$(strip $$$$(patsubst $$$$(keyword_eval)=%, %, $$$$(part)))) \ 862 $$(eval $1_NO_MATCH := ) \ 863 ) \ 864 ) \ 865 $$(foreach keyword, $$($1_STRING_KEYWORDS), \ 866 $$(eval keyword_eval := $$(call DoubleDollar, $$(keyword))) \ 867 $$(if $$(filter $$(keyword)=%, $$(part)), \ 868 $$(eval $(strip $1)_$$$$(keyword_eval) := $$$$(strip $$$$(subst %20, , $$$$(patsubst $$$$(keyword_eval)=%, %, $$$$(part))))) \ 869 $$(eval $1_NO_MATCH := ) \ 870 ) \ 871 ) \ 872 $$(if $$($1_NO_MATCH), \ 873 $$(if $$(filter $$(part), $$($1_KEYWORDS) $$($1_STRING_KEYWORDS)), \ 874 $$(info Keyword $$(part) for $1 needs to be assigned a value.) \ 875 , \ 876 $$(info $$(part) is not a valid keyword for $1.) \ 877 $$(info Valid keywords: $$($1_KEYWORDS) $$($1_STRING_KEYWORDS).) \ 878 ) \ 879 $$(error Cannot continue) \ 880 ) \ 881 ) 882 endif 883 endef 884 885 ################################################################################ 886 # ShellQuote 887 # 888 # Quotes a string with single quotes and replaces single quotes with '\'' so 889 # that the contents survives being given to the shell. 890 891 ShellQuote = \ 892 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 893 894 ################################################################################ 895 # FixPath 896 # 897 # On Windows, converts a path from cygwin/unix style (e.g. /bin/foo) into 898 # "mixed mode" (e.g. c:/cygwin/bin/foo). On other platforms, return the path 899 # unchanged. 900 # This is normally not needed since we use the FIXPATH prefix for command lines, 901 # but might be needed in certain circumstances. 902 ifeq ($(OPENJDK_TARGET_OS), windows) 903 FixPath = \ 904 $(shell $(CYGPATH) -m $1) 905 else 906 FixPath = \ 907 $1 908 endif 909 910 ################################################################################ 911 # Write to and read from file 912 913 # Param 1 - File to read 914 ReadFile = \ 915 $(shell $(CAT) $1) 916 917 # Param 1 - Text to write 918 # Param 2 - File to write to 919 ifeq ($(HAS_FILE_FUNCTION), true) 920 WriteFile = \ 921 $(file >$2,$(strip $1)) 922 else 923 # Use printf to get consistent behavior on all platforms. 924 WriteFile = \ 925 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 926 endif 927 928 # Param 1 - Text to write 929 # Param 2 - File to write to 930 ifeq ($(HAS_FILE_FUNCTION), true) 931 AppendFile = \ 932 $(file >>$2,$(strip $1)) 933 else 934 # Use printf to get consistent behavior on all platforms. 935 AppendFile = \ 936 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) >> $2) 937 endif 938 939 ################################################################################ 940 # DependOnVariable 941 # 942 # This macro takes a variable name and puts the value in a file only if the 943 # value has changed since last. The name of the file is returned. This can be 944 # used to create rule dependencies on make variable values. The following 945 # example would get rebuilt if the value of SOME_VAR was changed: 946 # 947 # path/to/some-file: $(call DependOnVariable, SOME_VAR) 948 # echo $(SOME_VAR) > $@ 949 # 950 # Note that leading and trailing white space in the value is ignored. 951 # 952 953 # Defines the sub directory structure to store variable value file in 954 DependOnVariableDirName = \ 955 $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \ 956 $(subst $(TOPDIR)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 957 $(firstword $(MAKEFILE_LIST)), \ 958 $(CURDIR)/$(firstword $(MAKEFILE_LIST)))))) 959 960 # Defines the name of the file to store variable value in. Generates a name 961 # unless parameter 2 is given. 962 # Param 1 - Name of variable 963 # Param 2 - (optional) name of file to store value in 964 DependOnVariableFileName = \ 965 $(strip $(if $(strip $2), $2, \ 966 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 967 968 # Does the actual work with parameters stripped. 969 # If the file exists AND the contents is the same as the variable, do nothing 970 # else print a new file. 971 # Always returns the name of the file where the value was printed. 972 # Param 1 - Name of variable 973 # Param 2 - (optional) name of file to store value in 974 DependOnVariableHelper = \ 975 $(strip \ 976 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 977 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 978 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 979 $(if $(findstring $(LOG_LEVEL), trace), \ 980 $(info NewVariable $1: >$(strip $($1))<) \ 981 $(info OldVariable $1: >$(strip $($1_old))<)) \ 982 $(call WriteFile, $1_old:=$(call DoubleDollar,$(call EscapeHash,$($1))), \ 983 $(call DependOnVariableFileName, $1, $2))) \ 984 $(call DependOnVariableFileName, $1, $2) \ 985 ) 986 987 # Main macro 988 # Param 1 - Name of variable 989 # Param 2 - (optional) name of file to store value in 990 DependOnVariable = \ 991 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 992 993 # LogCmdlines is only intended to be used by ExecuteWithLog 994 ifeq ($(LOG_CMDLINES), true) 995 LogCmdlines = $(info $(strip $1)) 996 else 997 LogCmdlines = 998 endif 999 1000 ################################################################################ 1001 # ExecuteWithLog will run a command and log the output appropriately. This is 1002 # meant to be used by commands that do "real" work, like a compilation. 1003 # The output is stored in a specified log file, which is displayed at the end 1004 # of the build in case of failure. The command line itself is stored in a file, 1005 # and also logged to stdout if the LOG=cmdlines option has been given. 1006 # 1007 # NOTE: If the command redirects stdout, the caller needs to wrap it in a 1008 # subshell (by adding parentheses around it), otherwise the redirect to the 1009 # subshell tee process will create a race condition where the target file may 1010 # not be fully written when the make recipe is done. 1011 # 1012 # Param 1 - The path to base the name of the log file / command line file on 1013 # Param 2 - The command to run 1014 ExecuteWithLog = \ 1015 $(call LogCmdlines, Exececuting: [$(strip $2)]) \ 1016 $(call MakeDir, $(dir $(strip $1))) \ 1017 $(call WriteFile, $2, $(strip $1).cmdline) \ 1018 ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \ 1019 ( exitcode=$(DOLLAR)? && \ 1020 $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(OUTPUTDIR)/%,%,$(strip $1))).log && \ 1021 $(CP) $(strip $1).cmdline $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(OUTPUTDIR)/%,%,$(strip $1))).cmdline && \ 1022 exit $(DOLLAR)exitcode ) ) 1023 1024 ################################################################################ 1025 # Find lib dir for module 1026 # Param 1 - module name 1027 FindLibDirForModule = \ 1028 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 1029 1030 ################################################################################ 1031 # Find executable dir for module 1032 # Param 1 - module name 1033 FindExecutableDirForModule = \ 1034 $(SUPPORT_OUTPUTDIR)/modules_cmds/$(strip $1) 1035 1036 ################################################################################ 1037 # Return a string suitable for use after a -classpath or --module-path option. It 1038 # will be correct and safe to use on all platforms. Arguments are given as space 1039 # separate classpath entries. Safe for multiple nested calls. 1040 # param 1 : A space separated list of classpath entries 1041 # The surrounding strip is needed to keep additional whitespace out 1042 PathList = \ 1043 "$(subst $(SPACE),$(PATH_SEP),$(strip $(subst $(DQUOTE),,$1)))" 1044 1045 ################################################################################ 1046 # Check if a specified hotspot variant is being built, or at least one of a 1047 # list of variants. Will return 'true' or 'false'. 1048 # $1 - the variant to test for 1049 check-jvm-variant = \ 1050 $(strip \ 1051 $(if $(filter-out $(VALID_JVM_VARIANTS), $1), \ 1052 $(error Internal error: Invalid variant tested: $1)) \ 1053 $(if $(filter $1, $(JVM_VARIANTS)), true, false)) 1054 1055 ################################################################################ 1056 # Converts a space separated list to a comma separated list. 1057 # 1058 # Replacing double-comma with a single comma is to workaround the issue with 1059 # some version of make on windows that doesn't substitute spaces with one comma 1060 # properly. 1061 CommaList = \ 1062 $(strip \ 1063 $(subst $(COMMA)$(COMMA),$(COMMA),$(subst $(SPACE),$(COMMA),$(strip $1))) \ 1064 ) 1065 1066 ################################################################################ 1067 # Converts a space separated list to a colon separated list. 1068 # 1069 # Replacing double-colon with a single colon is to workaround the issue with 1070 # some version of make on windows that doesn't substitute spaces with one colon 1071 # properly. 1072 ColonList = \ 1073 $(strip \ 1074 $(subst ::,:,$(subst $(SPACE),:,$(strip $1))) \ 1075 ) 1076 1077 ################################################################################ 1078 1079 # Hook to include the corresponding custom file, if present. 1080 $(eval $(call IncludeCustomExtension, common/MakeBase.gmk)) 1081 1082 endif # _MAKEBASE_GMK