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 = false 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 30001,$$($$(strip $1)))) 176 $$(error Cannot list safely more than 30000 paths. $1 has $$(words $$($$(strip $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 233 $$(call ListPathsSafely_IfPrintf,$1,$2,10001,10250) 234 $$(call ListPathsSafely_IfPrintf,$1,$2,10251,10500) 235 $$(call ListPathsSafely_IfPrintf,$1,$2,10501,10750) 236 $$(call ListPathsSafely_IfPrintf,$1,$2,10751,11000) 237 238 $$(call ListPathsSafely_IfPrintf,$1,$2,11001,11250) 239 $$(call ListPathsSafely_IfPrintf,$1,$2,11251,11500) 240 $$(call ListPathsSafely_IfPrintf,$1,$2,11501,11750) 241 $$(call ListPathsSafely_IfPrintf,$1,$2,11751,12000) 242 243 $$(call ListPathsSafely_IfPrintf,$1,$2,12001,12250) 244 $$(call ListPathsSafely_IfPrintf,$1,$2,12251,12500) 245 $$(call ListPathsSafely_IfPrintf,$1,$2,12501,12750) 246 $$(call ListPathsSafely_IfPrintf,$1,$2,12751,13000) 247 248 $$(call ListPathsSafely_IfPrintf,$1,$2,13001,13250) 249 $$(call ListPathsSafely_IfPrintf,$1,$2,13251,13500) 250 $$(call ListPathsSafely_IfPrintf,$1,$2,13501,13750) 251 $$(call ListPathsSafely_IfPrintf,$1,$2,13751,14000) 252 253 $$(call ListPathsSafely_IfPrintf,$1,$2,14001,14250) 254 $$(call ListPathsSafely_IfPrintf,$1,$2,14251,14500) 255 $$(call ListPathsSafely_IfPrintf,$1,$2,14501,14750) 256 $$(call ListPathsSafely_IfPrintf,$1,$2,14751,15000) 257 258 $$(call ListPathsSafely_IfPrintf,$1,$2,15001,15250) 259 $$(call ListPathsSafely_IfPrintf,$1,$2,15251,15500) 260 $$(call ListPathsSafely_IfPrintf,$1,$2,15501,15750) 261 $$(call ListPathsSafely_IfPrintf,$1,$2,15751,16000) 262 263 $$(call ListPathsSafely_IfPrintf,$1,$2,16001,16250) 264 $$(call ListPathsSafely_IfPrintf,$1,$2,16251,16500) 265 $$(call ListPathsSafely_IfPrintf,$1,$2,16501,16750) 266 $$(call ListPathsSafely_IfPrintf,$1,$2,16751,17000) 267 268 $$(call ListPathsSafely_IfPrintf,$1,$2,17001,17250) 269 $$(call ListPathsSafely_IfPrintf,$1,$2,17251,17500) 270 $$(call ListPathsSafely_IfPrintf,$1,$2,17501,17750) 271 $$(call ListPathsSafely_IfPrintf,$1,$2,17751,18000) 272 273 $$(call ListPathsSafely_IfPrintf,$1,$2,18001,18250) 274 $$(call ListPathsSafely_IfPrintf,$1,$2,18251,18500) 275 $$(call ListPathsSafely_IfPrintf,$1,$2,18501,18750) 276 $$(call ListPathsSafely_IfPrintf,$1,$2,18751,19000) 277 278 $$(call ListPathsSafely_IfPrintf,$1,$2,19001,19250) 279 $$(call ListPathsSafely_IfPrintf,$1,$2,19251,19500) 280 $$(call ListPathsSafely_IfPrintf,$1,$2,19501,19750) 281 $$(call ListPathsSafely_IfPrintf,$1,$2,19751,20000) 282 283 $$(call ListPathsSafely_IfPrintf,$1,$2,20001,20250) 284 $$(call ListPathsSafely_IfPrintf,$1,$2,20251,20500) 285 $$(call ListPathsSafely_IfPrintf,$1,$2,20501,20750) 286 $$(call ListPathsSafely_IfPrintf,$1,$2,20751,21000) 287 288 $$(call ListPathsSafely_IfPrintf,$1,$2,21001,21250) 289 $$(call ListPathsSafely_IfPrintf,$1,$2,21251,21500) 290 $$(call ListPathsSafely_IfPrintf,$1,$2,21501,21750) 291 $$(call ListPathsSafely_IfPrintf,$1,$2,21751,22000) 292 293 $$(call ListPathsSafely_IfPrintf,$1,$2,22001,22250) 294 $$(call ListPathsSafely_IfPrintf,$1,$2,22251,22500) 295 $$(call ListPathsSafely_IfPrintf,$1,$2,22501,22750) 296 $$(call ListPathsSafely_IfPrintf,$1,$2,22751,23000) 297 298 $$(call ListPathsSafely_IfPrintf,$1,$2,23001,23250) 299 $$(call ListPathsSafely_IfPrintf,$1,$2,23251,23500) 300 $$(call ListPathsSafely_IfPrintf,$1,$2,23501,23750) 301 $$(call ListPathsSafely_IfPrintf,$1,$2,23751,24000) 302 303 $$(call ListPathsSafely_IfPrintf,$1,$2,24001,24250) 304 $$(call ListPathsSafely_IfPrintf,$1,$2,24251,24500) 305 $$(call ListPathsSafely_IfPrintf,$1,$2,24501,24750) 306 $$(call ListPathsSafely_IfPrintf,$1,$2,24751,25000) 307 308 $$(call ListPathsSafely_IfPrintf,$1,$2,25001,25250) 309 $$(call ListPathsSafely_IfPrintf,$1,$2,25251,25500) 310 $$(call ListPathsSafely_IfPrintf,$1,$2,25501,25750) 311 $$(call ListPathsSafely_IfPrintf,$1,$2,25751,26000) 312 313 $$(call ListPathsSafely_IfPrintf,$1,$2,26001,26250) 314 $$(call ListPathsSafely_IfPrintf,$1,$2,26251,26500) 315 $$(call ListPathsSafely_IfPrintf,$1,$2,26501,26750) 316 $$(call ListPathsSafely_IfPrintf,$1,$2,26751,27000) 317 318 $$(call ListPathsSafely_IfPrintf,$1,$2,27001,27250) 319 $$(call ListPathsSafely_IfPrintf,$1,$2,27251,27500) 320 $$(call ListPathsSafely_IfPrintf,$1,$2,27501,27750) 321 $$(call ListPathsSafely_IfPrintf,$1,$2,27751,28000) 322 323 $$(call ListPathsSafely_IfPrintf,$1,$2,28001,28250) 324 $$(call ListPathsSafely_IfPrintf,$1,$2,28251,28500) 325 $$(call ListPathsSafely_IfPrintf,$1,$2,28501,28750) 326 $$(call ListPathsSafely_IfPrintf,$1,$2,28751,29000) 327 328 $$(call ListPathsSafely_IfPrintf,$1,$2,29001,29250) 329 $$(call ListPathsSafely_IfPrintf,$1,$2,29251,29500) 330 $$(call ListPathsSafely_IfPrintf,$1,$2,29501,29750) 331 $$(call ListPathsSafely_IfPrintf,$1,$2,29751,30000) 332 endef 333 endif # HAS_FILE_FUNCTION 334 335 ################################################################################ 336 # The source tips can come from the Mercurial repository, or in the files 337 # $(HGTIP_FILENAME) which contains the tip but is also positioned in the same 338 # directory as the original .hg directory. The hgtip files are created in 339 # CreateHgtipFiles.gmk. 340 HGTIP_FILENAME := .hgtip 341 FindAllReposAbs = \ 342 $(strip $(sort $(dir $(filter-out $(SRC_ROOT)/build/%, $(wildcard \ 343 $(addprefix $(SRC_ROOT)/, \ 344 .hg */.hg */*/.hg */*/.hg */*/*/.hg \ 345 .hgtip */.hgtip */*/.hgtip */*/.hgtip */*/*/.hgtip \ 346 ) \ 347 ))))) 348 349 FindAllReposRel = \ 350 $(strip $(subst $(SRC_ROOT)/,.,$(patsubst $(SRC_ROOT)/%/, %, $(FindAllReposAbs)))) 351 352 # Emit the repo:tip pairs to $@, but only if they changed since last time 353 define GetSourceTips 354 $(CD) $(SRC_ROOT) ; \ 355 for i in $(FindAllReposRel) IGNORE ; do \ 356 if [ "$${i}" = "IGNORE" ] ; then \ 357 continue; \ 358 elif [ -d $${i}/.hg -a "$(HG)" != "" ] ; then \ 359 $(PRINTF) " %s:%s" \ 360 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \ 361 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \ 362 $(PRINTF) " %s:%s" \ 363 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \ 364 fi; \ 365 done > $@.tmp 366 $(PRINTF) "\n" >> $@.tmp 367 if [ ! -f $@ ] || [ "`$(CAT) $@`" != "`$(CAT) $@.tmp`" ]; then \ 368 $(MV) $@.tmp $@ ; \ 369 else \ 370 $(RM) $@.tmp ; \ 371 fi 372 endef 373 374 ################################################################################ 375 376 define SetupLogging 377 ifeq ($$(LOG_LEVEL), trace) 378 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 379 # For each target executed, will print 380 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 381 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 382 # (and causing a crash on Cygwin). 383 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 384 # Only use time if it's GNU time which supports format and output file. 385 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 386 SHELL = $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 387 endif 388 # The warn level can never be turned off 389 LogWarn = $$(info $$(strip $$1)) 390 LOG_WARN := 391 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 392 LogInfo = $$(info $$(strip $$1)) 393 LOG_INFO := 394 else 395 LogInfo = 396 LOG_INFO := > /dev/null 397 endif 398 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 399 LogDebug = $$(info $$(strip $$1)) 400 LOG_DEBUG := 401 else 402 LogDebug = 403 LOG_DEBUG := > /dev/null 404 endif 405 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 406 LogTrace = $$(info $$(strip $$1)) 407 LOG_TRACE := 408 else 409 LogTrace = 410 LOG_TRACE := > /dev/null 411 endif 412 endef 413 414 # Make sure logging is setup for everyone that includes MakeBase.gmk. 415 $(eval $(call SetupLogging)) 416 417 ################################################################################ 418 # Creates a sequence of increasing numbers (inclusive). 419 # Param 1 - starting number 420 # Param 2 - ending number 421 sequence = \ 422 $(wordlist $1, $2, $(strip \ 423 $(eval SEQUENCE_COUNT :=) \ 424 $(call _sequence-do,$(strip $2)))) 425 426 _sequence-do = \ 427 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 428 $(eval SEQUENCE_COUNT += .) \ 429 $(words $(SEQUENCE_COUNT)) \ 430 $(call _sequence-do,$1)) 431 432 ################################################################################ 433 434 MAX_PARAMS := 35 435 PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 436 437 # Template for creating a macro taking named parameters. To use it, assign the 438 # template to a variable with the name you want for your macro, using '=' 439 # assignment. Then define a macro body with the suffix "Body". The Body macro 440 # should take 1 parameter which should be a unique string for that invocation 441 # of the macro. 442 # Ex: 443 # SetupFoo = $(NamedParamsMacroTemplate) 444 # define SetupFooBody 445 # # do something 446 # # access parameters as $$($1_BAR) 447 # endef 448 # Call it like this 449 # $(eval $(call SetupFoo, BUILD_SOMETHING, \ 450 # BAR := some parameter value, \ 451 # )) 452 define NamedParamsMacroTemplate 453 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 454 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 455 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 456 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 457 $(strip $1)_$(strip $(call DoubleDollar, $($i))))$(NEWLINE)) 458 # Debug print all named parameter names and values 459 $(if $(findstring $(LOG_LEVEL),debug trace), \ 460 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 461 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 462 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 463 464 $(if $(DEBUG_$(strip $1)), 465 $(info -------- <<< Begin expansion of $(strip $1)) \ 466 $(info $(call $(0)Body,$(strip $1))) \ 467 $(info -------- >>> End expansion of $(strip $1)) \ 468 ) 469 470 $(call $(0)Body,$(strip $1)) 471 endef 472 473 ################################################################################ 474 # Make directory without forking mkdir if not needed 475 # 1: List of directories to create 476 MakeDir = \ 477 $(strip \ 478 $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, $(if $(wildcard $d), , $d)))) \ 479 $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \ 480 ) 481 482 ################################################################################ 483 # Assign a variable only if it is empty 484 # Param 1 - Variable to assign 485 # Param 2 - Value to assign 486 SetIfEmpty = \ 487 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 488 489 ################################################################################ 490 491 ifeq ($(OPENJDK_TARGET_OS),solaris) 492 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 493 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 494 # name of the target file differs from the source file, rename after copy. 495 # If the source and target parent directories are the same, recursive copy doesn't work 496 # so we fall back on regular copy, which isn't preserving symlinks. 497 define install-file 498 $(MKDIR) -p '$(@D)' 499 $(RM) '$@' 500 if [ "$(@D)" != "$(<D)" ]; then \ 501 $(CP) -f -r -P '$<' '$(@D)'; \ 502 if [ "$(@F)" != "$(<F)" ]; then \ 503 $(MV) '$(@D)/$(<F)' '$@'; \ 504 fi; \ 505 else \ 506 if [ -L '$<' ]; then \ 507 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 508 exit 1; \ 509 fi; \ 510 $(CP) -f '$<' '$@'; \ 511 fi 512 endef 513 else ifeq ($(OPENJDK_TARGET_OS),macosx) 514 # On mac, extended attributes sometimes creep into the source files, which may later 515 # cause the creation of ._* files which confuses testing. Clear these with xattr if 516 # set. Some files get their write permissions removed after being copied to the 517 # output dir. When these are copied again to images, xattr would fail. By only clearing 518 # attributes when they are present, failing on this is avoided. 519 # 520 # If copying a soft link to a directory, need to delete the target first to avoid 521 # weird errors. 522 define install-file 523 $(MKDIR) -p '$(@D)' 524 $(RM) '$@' 525 $(CP) -fRP '$<' '$@' 526 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 527 endef 528 else 529 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 530 # significantly. 531 define install-file 532 $(call MakeDir, $(@D)) 533 $(CP) -fP '$<' '$@' 534 endef 535 endif 536 537 ################################################################################ 538 # Take two paths and return the path of the last common directory. 539 # Ex: /foo/bar/baz, /foo/bar/banan -> /foo/bar 540 # foo/bar/baz, /foo/bar -> <empty> 541 # 542 # The x prefix is used to preserve the presence of the initial slash 543 # 544 # $1 - Path to compare 545 # $2 - Other path to compare 546 FindCommonPathPrefix = \ 547 $(patsubst x%,%,$(subst $(SPACE),/,$(strip \ 548 $(call FindCommonPathPrefixHelper, \ 549 $(subst /,$(SPACE),x$(strip $1)), $(subst /,$(SPACE),x$(strip $2))) \ 550 ))) 551 552 FindCommonPathPrefixHelper = \ 553 $(if $(call equals, $(firstword $1), $(firstword $2)), \ 554 $(firstword $1) \ 555 $(call FindCommonPathPrefixHelper, \ 556 $(wordlist 2, $(words $1), $1), $(wordlist 2, $(words $2), $2) \ 557 ) \ 558 ) 559 560 # Convert a partial path into as many directory levels of ../, removing 561 # leading and following /. 562 # Ex: foo/bar/baz/ -> ../../.. 563 # foo/bar -> ../.. 564 # /foo -> .. 565 DirToDotDot = \ 566 $(subst $(SPACE),/,$(foreach d, $(subst /,$(SPACE),$1),..)) 567 568 # Computes the relative path from a directory to a file 569 # $1 - File to compute the relative path to 570 # $2 - Directory to compute the relative path from 571 RelativePath = \ 572 $(eval $1_prefix := $(call FindCommonPathPrefix, $1, $2)) \ 573 $(eval $1_dotdots := $(call DirToDotDot, $(patsubst $($(strip $1)_prefix)/%, %, $2))) \ 574 $(eval $1_suffix := $(patsubst $($(strip $1)_prefix)/%, %, $1)) \ 575 $($(strip $1)_dotdots)/$($(strip $1)_suffix) 576 577 ################################################################################ 578 # link-file-* works similarly to install-file but creates a symlink instead. 579 # There are two versions, either creating a relative or an absolute link. Be 580 # careful when using this on Windows since the symlink created is only valid in 581 # the unix emulation environment. 582 define link-file-relative 583 $(call MakeDir, $(@D)) 584 $(RM) $@ 585 $(LN) -s $(call RelativePath, $<, $(@D)) $@ 586 endef 587 588 define link-file-absolute 589 $(call MakeDir, $(@D)) 590 $(RM) $@ 591 $(LN) -s $< $@ 592 endef 593 594 ################################################################################ 595 # Filter out duplicate sub strings while preserving order. Keeps the first occurance. 596 uniq = \ 597 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 598 599 # Returns all whitespace-separated words in $2 where at least one of the 600 # whitespace-separated words in $1 is a substring. 601 containing = \ 602 $(strip \ 603 $(foreach v,$(strip $2),\ 604 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 605 606 # Returns all whitespace-separated words in $2 where none of the 607 # whitespace-separated words in $1 is a substring. 608 not-containing = \ 609 $(strip $(filter-out $(call containing,$1,$2),$2)) 610 611 # Return a list of all string elements that are duplicated in $1. 612 dups = \ 613 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 614 $(words $(filter $v, $1))), $v))) 615 616 # String equals 617 equals = \ 618 $(and $(findstring $(strip $1),$(strip $2)),\ 619 $(findstring $(strip $2),$(strip $1))) 620 621 # Remove a whole list of prefixes 622 # $1 - List of prefixes 623 # $2 - List of elements to process 624 remove-prefixes = \ 625 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 626 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 627 628 # Convert the string given to upper case, without any $(shell) 629 # Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html 630 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 \ 631 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z 632 633 uppercase_internal = \ 634 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \ 635 $(wordlist 2, $(words $1), $1), $2)), $2) 636 637 # Convert a string to upper case. Works only on a-z. 638 # $1 - The string to convert 639 uppercase = \ 640 $(strip \ 641 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \ 642 $(uppercase_result) \ 643 ) 644 645 ################################################################################ 646 647 ifneq ($(DISABLE_CACHE_FIND), true) 648 # In Cygwin, finds are very costly, both because of expensive forks and because 649 # of bad file system caching. Find is used extensively in $(shell) commands to 650 # find source files. This makes rerunning make with no or few changes rather 651 # expensive. To speed this up, these two macros are used to cache the results 652 # of simple find commands for reuse. 653 # 654 # Runs a find and stores both the directories where it was run and the results. 655 # This macro can be called multiple times to add to the cache. Only finds files 656 # with no filters. 657 # 658 # Needs to be called with $(eval ) 659 # 660 # Even if the performance benifit is negligible on other platforms, keep the 661 # functionality active unless explicitly disabled to exercise it more. 662 # 663 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 664 FIND_CACHE_DIRS := 665 # Param 1 - Dirs to find in 666 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 667 define FillCacheFind 668 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 669 # since filter out will then return empty. 670 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 671 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 672 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 673 # Remove any trailing slash from dirs in the cache dir list 674 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 675 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 676 endif 677 endef 678 679 # Mimics find by looking in the cache if all of the directories have been cached. 680 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 681 # cache is deactivated. 682 # 683 # $1 can be either a directory or a file. If it's a directory, make 684 # sure we have exactly one trailing slash before the wildcard. 685 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 686 # 687 # Param 1 - Dirs to find in 688 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 689 define CacheFind 690 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 691 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 692 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 693 endef 694 695 else 696 # If CacheFind is disabled, just run the find command. 697 # Param 1 - Dirs to find in 698 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 699 define CacheFind 700 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 701 endef 702 endif 703 704 ################################################################################ 705 706 define AddFileToCopy 707 # Helper macro for SetupCopyFiles 708 # 1 : Source file 709 # 2 : Dest file 710 # 3 : Variable to add targets to 711 # 4 : Macro to call for copy operation 712 $2: $1 713 $$(call LogInfo, Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@)) 714 $$($$(strip $4)) 715 716 $3 += $2 717 endef 718 719 # Returns the value of the first argument 720 identity = \ 721 $(strip $1) 722 723 # Setup make rules for copying files, with an option to do more complex 724 # processing instead of copying. 725 # 726 # Parameter 1 is the name of the rule. This name is used as variable prefix, 727 # and the targets generated are listed in a variable by that name. 728 # 729 # Remaining parameters are named arguments. These include: 730 # SRC : Source root dir (defaults to dir of first file) 731 # DEST : Dest root dir 732 # FILES : List of files to copy with absolute paths, or path relative to SRC. 733 # Must be in SRC. 734 # FLATTEN : Set to flatten the directory structure in the DEST dir. 735 # MACRO : Optionally override the default macro used for making the copy. 736 # Default is 'install-file' 737 # NAME_MACRO : Optionally supply a macro that rewrites the target file name 738 # based on the source file name 739 SetupCopyFiles = $(NamedParamsMacroTemplate) 740 define SetupCopyFilesBody 741 742 ifeq ($$($1_MACRO), ) 743 $1_MACRO := install-file 744 endif 745 746 # Default SRC to the dir of the first file. 747 ifeq ($$($1_SRC), ) 748 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 749 endif 750 751 ifeq ($$($1_NAME_MACRO), ) 752 $1_NAME_MACRO := identity 753 endif 754 755 # Remove any trailing slash from SRC and DEST 756 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 757 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 758 759 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 760 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 761 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \ 762 $1, $$($1_MACRO)))) 763 764 endef 765 766 ################################################################################ 767 # ShellQuote 768 # 769 # Quotes a string with single quotes and replaces single quotes with '\'' so 770 # that the contents survives being given to the shell. 771 772 ShellQuote = \ 773 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 774 775 ################################################################################ 776 # Write to and read from file 777 778 # Param 1 - File to read 779 ReadFile = \ 780 $(shell $(CAT) $1) 781 782 # Param 1 - Text to write 783 # Param 2 - File to write to 784 ifeq ($(HAS_FILE_FUNCTION), true) 785 WriteFile = \ 786 $(file >$2,$(strip $1)) 787 else 788 # Use printf to get consistent behavior on all platforms. 789 WriteFile = \ 790 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 791 endif 792 793 ################################################################################ 794 # DependOnVariable 795 # 796 # This macro takes a variable name and puts the value in a file only if the 797 # value has changed since last. The name of the file is returned. This can be 798 # used to create rule dependencies on make variable values. The following 799 # example would get rebuilt if the value of SOME_VAR was changed: 800 # 801 # path/to/some-file: $(call DependOnVariable, SOME_VAR) 802 # echo $(SOME_VAR) > $@ 803 # 804 # Note that leading and trailing white space in the value is ignored. 805 # 806 807 # Defines the sub directory structure to store variable value file in 808 DependOnVariableDirName = \ 809 $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \ 810 $(subst $(SRC_ROOT)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 811 $(firstword $(MAKEFILE_LIST)), \ 812 $(CURDIR)/$(firstword $(MAKEFILE_LIST)))))) 813 814 # Defines the name of the file to store variable value in. Generates a name 815 # unless parameter 2 is given. 816 # Param 1 - Name of variable 817 # Param 2 - (optional) name of file to store value in 818 DependOnVariableFileName = \ 819 $(strip $(if $(strip $2), $2, \ 820 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 821 822 # Does the actual work with parameters stripped. 823 # If the file exists AND the contents is the same as the variable, do nothing 824 # else print a new file. 825 # Always returns the name of the file where the value was printed. 826 # Param 1 - Name of variable 827 # Param 2 - (optional) name of file to store value in 828 DependOnVariableHelper = \ 829 $(strip \ 830 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 831 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 832 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 833 $(if $(findstring $(LOG_LEVEL), trace), \ 834 $(info NewVariable $1: >$(strip $($1))<) \ 835 $(info OldVariable $1: >$(strip $($1_old))<)) \ 836 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \ 837 $(call DependOnVariableFileName, $1, $2))) \ 838 $(call DependOnVariableFileName, $1, $2) \ 839 ) 840 841 # Main macro 842 # Param 1 - Name of variable 843 # Param 2 - (optional) name of file to store value in 844 DependOnVariable = \ 845 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 846 847 # LogCmdlines is only intended to be used by ExecuteWithLog 848 ifeq ($(LOG_CMDLINES), true) 849 LogCmdlines = $(info $(strip $1)) 850 else 851 LogCmdlines = 852 endif 853 854 ################################################################################ 855 # ExecuteWithLog will run a command and log the output appropriately. This is 856 # meant to be used by commands that do "real" work, like a compilation. 857 # The output is stored in a specified log file, which is displayed at the end 858 # of the build in case of failure. The command line itself is stored in a file, 859 # and also logged to stdout if the LOG=cmdlines option has been given. 860 # 861 # NOTE: If the command redirects stdout, the caller needs to wrap it in a 862 # subshell (by adding parentheses around it), otherwise the redirect to the 863 # subshell tee process will create a race condition where the target file may 864 # not be fully written when the make recipe is done. 865 # 866 # Param 1 - The path to base the name of the log file / command line file on 867 # Param 2 - The command to run 868 ExecuteWithLog = \ 869 $(call LogCmdlines, Exececuting: [$(strip $2)]) \ 870 $(call WriteFile, $2, $(strip $1).cmdline) \ 871 ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \ 872 ( exitcode=$(DOLLAR)? && \ 873 $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(BUILD_OUTPUT)/%,%,$(strip $1))).log && \ 874 exit $(DOLLAR)exitcode ) ) 875 876 ################################################################################ 877 # Find lib dir for module 878 # Param 1 - module name 879 FindLibDirForModule = \ 880 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 881 882 ################################################################################ 883 # Return a string suitable for use after a -classpath or --module-path option. It 884 # will be correct and safe to use on all platforms. Arguments are given as space 885 # separate classpath entries. Safe for multiple nested calls. 886 # param 1 : A space separated list of classpath entries 887 # The surrounding strip is needed to keep additional whitespace out 888 PathList = \ 889 "$(subst $(SPACE),$(PATH_SEP),$(strip $(subst $(DQUOTE),,$1)))" 890 891 ################################################################################ 892 # Check if a specified hotspot variant is being built, or at least one of a 893 # list of variants. Will return 'true' or 'false'. 894 # $1 - the variant to test for 895 check-jvm-variant = \ 896 $(strip \ 897 $(if $(filter-out $(VALID_JVM_VARIANTS), $1), \ 898 $(error Internal error: Invalid variant tested: $1)) \ 899 $(if $(filter $1, $(JVM_VARIANTS)), true, false)) 900 901 ################################################################################ 902 # Converts a space separated list to a comma separated list. 903 # 904 # Replacing double-comma with a single comma is to workaround the issue with 905 # some version of make on windows that doesn't substitute spaces with one comma 906 # properly. 907 CommaList = \ 908 $(strip \ 909 $(subst $(COMMA)$(COMMA),$(COMMA),$(subst $(SPACE),$(COMMA),$(strip $1))) \ 910 ) 911 912 ################################################################################ 913 914 # Hook to include the corresponding custom file, if present. 915 $(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 916 917 endif # _MAKEBASE_GMK