MakeBase.gmk revision 2084:7de7decfd096
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 32ifndef _MAKEBASE_GMK 33_MAKEBASE_GMK := 1 34 35ifeq ($(wildcard $(SPEC)),) 36 $(error MakeBase.gmk needs SPEC set to a proper spec.gmk) 37endif 38 39# By defining this pseudo target, make will automatically remove targets 40# if their recipe fails so that a rebuild is automatically triggered on the 41# next make invocation. 42.DELETE_ON_ERROR: 43 44################################################################################ 45# Definitions for special characters 46################################################################################ 47 48# When calling macros, the spaces between arguments are 49# often semantically important! Sometimes we need to subst 50# spaces and commas, therefore we need the following macros. 51X:= 52SPACE:=$(X) $(X) 53COMMA:=, 54DOLLAR:=$$ 55HASH:=\# 56LEFT_PAREN:=( 57RIGHT_PAREN:=) 58SQUOTE:=' 59#' 60DQUOTE:=" 61#" 62define NEWLINE 63 64 65endef 66 67# In GNU Make 4.0 and higher, there is a file function for writing to files. 68ifeq (4.0, $(firstword $(sort 4.0 $(MAKE_VERSION)))) 69 HAS_FILE_FUNCTION := true 70endif 71 72############################## 73# Functions 74############################## 75 76### Debug functions 77 78# Prints the name and value of a variable 79PrintVar = \ 80 $(info $(strip $1) >$($(strip $1))<) 81 82### Functions for timers 83 84# Store the build times in this directory. 85BUILDTIMESDIR=$(OUTPUT_ROOT)/make-support/build-times 86 87# Record starting time for build of a sub repository. 88define RecordStartTime 89 $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_start_$(strip $1) && \ 90 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$(strip $1)_human_readable 91endef 92 93# Record ending time and calculate the difference and store it in a 94# easy to read format. Handles builds that cross midnight. Expects 95# that a build will never take 24 hours or more. 96define RecordEndTime 97 $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_end_$(strip $1) 98 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)_human_readable 99 $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$(strip $1)` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$(strip $1)` $1 | \ 100 $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ 101 M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ 102 > $(BUILDTIMESDIR)/build_time_diff_$(strip $1) 103endef 104 105# Hook to be called when starting to execute a top-level target 106define TargetEnter 107 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 108 $(call RecordStartTime,$(patsubst %-only,%,$@)) 109endef 110 111# Hook to be called when finish executing a top-level target 112define TargetExit 113 $(call RecordEndTime,$(patsubst %-only,%,$@)) 114 $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ 115 "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" 116endef 117 118################################################################################ 119# This macro translates $ into \$ to protect the $ from expansion in the shell. 120# To make this macro resilient against already escaped strings, first remove 121# any present escapes before escaping so that no double escapes are added. 122EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 123 124################################################################################ 125# This macro translates $ into $$ to protect the string from make itself. 126DoubleDollar = $(subst $$,$$$$,$(strip $1)) 127 128################################################################################ 129# ListPathsSafely can be used to print command parameters to a file. This is 130# typically done if the command line lenght risk being too long for the 131# OS/shell. In later make versions, the file function can be used for this 132# purpose. For earlier versions, a more complex implementation is provided. 133# 134# The function ListPathsSafely can be called either directly or, more commonly 135# from a recipe line. If called from a recipe, it will be executed in the 136# evaluation phase of that recipe, which means that it will write to the file 137# before any other line in the recipe has been run. 138ifeq ($(HAS_FILE_FUNCTION), true) 139 # Param 1 - Name of variable containing paths/arguments to output 140 # Param 2 - File to print to 141 # Param 3 - Set to true to append to file instead of overwriting 142 define ListPathsSafely 143 $$(call MakeDir, $$(dir $$(strip $2))) 144 $$(file $$(if $$(filter true, $$(strip $3)),>>,>) \ 145 $$(strip $2),$$(subst $$(SPACE),$$(NEWLINE),$$(strip $$($$(strip $1))))) 146 endef 147 148else # HAS_FILE_FUNCTION = 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 333endif # 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 $(HGDIR) directory. 339# These should not be := assignments, only used from the root Makefile. 340HG_VERSION = $(shell $(HG) version 2> /dev/null) 341HG_DIRECTORY=.hg 342HGTIP_FILENAME=.hgtip 343HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO 344REPO_LIST = $(patsubst ./%,%,$(patsubst %/,%,$(sort $(dir \ 345 $(shell $(CD) $(SRC_ROOT) ; \ 346 $(LS) -d $(HG_SEARCH:%/REPO=%/$(HG_DIRECTORY)) \ 347 $(HG_SEARCH:%/REPO=%/$(HGTIP_FILENAME)) \ 348 2> /dev/null))))) 349 350# Emit the repo:tip pairs to $@, but only if they changed since last time 351define GetSourceTips 352 $(CD) $(SRC_ROOT) ; \ 353 for i in $(REPO_LIST) IGNORE ; do \ 354 if [ "$${i}" = "IGNORE" ] ; then \ 355 continue; \ 356 elif [ -d $${i}/$(HG_DIRECTORY) -a "$(HG_VERSION)" != "" ] ; then \ 357 $(PRINTF) " %s:%s" \ 358 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \ 359 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \ 360 $(PRINTF) " %s:%s" \ 361 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \ 362 fi; \ 363 done > $@.tmp 364 $(PRINTF) "\n" >> $@.tmp 365 if [ ! -f $@ ] || [ "`$(CAT) $@`" != "`$(CAT) $@.tmp`" ]; then \ 366 $(MV) $@.tmp $@ ; \ 367 else \ 368 $(RM) $@.tmp ; \ 369 fi 370endef 371 372# Create the HGTIP_FILENAME file. Called from closed/make/SourceBundles.gmk 373define CreateHgTip 374 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \ 375 $(ECHO) $1/$(HGTIP_FILENAME) 376endef 377 378################################################################################ 379 380define SetupLogging 381 ifeq ($$(LOG_LEVEL), trace) 382 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 383 # For each target executed, will print 384 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 385 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 386 # (and causing a crash on Cygwin). 387 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 388 # Only use time if it's GNU time which supports format and output file. 389 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 390 SHELL = $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 391 endif 392 # The warn level can never be turned off 393 LogWarn = $$(info $$(strip $$1)) 394 LOG_WARN := 395 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 396 LogInfo = $$(info $$(strip $$1)) 397 LOG_INFO := 398 else 399 LogInfo = 400 LOG_INFO := > /dev/null 401 endif 402 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 403 LogDebug = $$(info $$(strip $$1)) 404 LOG_DEBUG := 405 else 406 LogDebug = 407 LOG_DEBUG := > /dev/null 408 endif 409 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 410 LogTrace = $$(info $$(strip $$1)) 411 LOG_TRACE := 412 else 413 LogTrace = 414 LOG_TRACE := > /dev/null 415 endif 416endef 417 418# Make sure logging is setup for everyone that includes MakeBase.gmk. 419$(eval $(call SetupLogging)) 420 421################################################################################ 422# Creates a sequence of increasing numbers (inclusive). 423# Param 1 - starting number 424# Param 2 - ending number 425sequence = \ 426 $(wordlist $1, $2, $(strip \ 427 $(eval SEQUENCE_COUNT :=) \ 428 $(call _sequence-do,$(strip $2)))) 429 430_sequence-do = \ 431 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 432 $(eval SEQUENCE_COUNT += .) \ 433 $(words $(SEQUENCE_COUNT)) \ 434 $(call _sequence-do,$1)) 435 436################################################################################ 437 438MAX_PARAMS := 35 439PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 440 441# Template for creating a macro taking named parameters. To use it, assign the 442# template to a variable with the name you want for your macro, using '=' 443# assignment. Then define a macro body with the suffix "Body". The Body macro 444# should take 1 parameter which should be a unique string for that invocation 445# of the macro. 446# Ex: 447# SetupFoo = $(NamedParamsMacroTemplate) 448# define SetupFooBody 449# # do something 450# # access parameters as $$($1_BAR) 451# endef 452# Call it like this 453# $(eval $(call SetupFoo, BUILD_SOMETHING, \ 454# BAR := some parameter value, \ 455# )) 456define NamedParamsMacroTemplate 457 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 458 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 459 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 460 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 461 $(strip $1)_$(strip $($i)))$(NEWLINE)) 462 # Debug print all named parameter names and values 463 $(if $(findstring $(LOG_LEVEL),debug trace), \ 464 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 465 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 466 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 467 468 $(if $(DEBUG_$(strip $1)), 469 $(info -------- <<< Begin expansion of $(strip $1)) \ 470 $(info $(call $(0)Body,$(strip $1))) \ 471 $(info -------- >>> End expansion of $(strip $1)) \ 472 ) 473 474 $(call $(0)Body,$(strip $1)) 475endef 476 477################################################################################ 478# Make directory without forking mkdir if not needed 479# 1: List of directories to create 480MakeDir = \ 481 $(strip \ 482 $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, $(if $(wildcard $d), , $d)))) \ 483 $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \ 484 ) 485 486################################################################################ 487# Assign a variable only if it is empty 488# Param 1 - Variable to assign 489# Param 2 - Value to assign 490SetIfEmpty = \ 491 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 492 493################################################################################ 494 495ifeq ($(OPENJDK_TARGET_OS),solaris) 496 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 497 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 498 # name of the target file differs from the source file, rename after copy. 499 # If the source and target parent directories are the same, recursive copy doesn't work 500 # so we fall back on regular copy, which isn't preserving symlinks. 501 define install-file 502 $(MKDIR) -p '$(@D)' 503 $(RM) '$@' 504 if [ "$(@D)" != "$(<D)" ]; then \ 505 $(CP) -f -r -P '$<' '$(@D)'; \ 506 if [ "$(@F)" != "$(<F)" ]; then \ 507 $(MV) '$(@D)/$(<F)' '$@'; \ 508 fi; \ 509 else \ 510 if [ -L '$<' ]; then \ 511 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 512 exit 1; \ 513 fi; \ 514 $(CP) -f '$<' '$@'; \ 515 fi 516 endef 517else ifeq ($(OPENJDK_TARGET_OS),macosx) 518 # On mac, extended attributes sometimes creep into the source files, which may later 519 # cause the creation of ._* files which confuses testing. Clear these with xattr if 520 # set. Some files get their write permissions removed after being copied to the 521 # output dir. When these are copied again to images, xattr would fail. By only clearing 522 # attributes when they are present, failing on this is avoided. 523 # 524 # If copying a soft link to a directory, need to delete the target first to avoid 525 # weird errors. 526 define install-file 527 $(MKDIR) -p '$(@D)' 528 $(RM) '$@' 529 $(CP) -fRP '$<' '$@' 530 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 531 endef 532else 533 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 534 # significantly. 535 define install-file 536 $(call MakeDir, $(@D)) 537 $(CP) -fP '$<' '$@' 538 endef 539endif 540 541################################################################################ 542# Filter out duplicate sub strings while preserving order. Keeps the first occurance. 543uniq = \ 544 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 545 546# Returns all whitespace-separated words in $2 where at least one of the 547# whitespace-separated words in $1 is a substring. 548containing = \ 549 $(strip \ 550 $(foreach v,$(strip $2),\ 551 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 552 553# Returns all whitespace-separated words in $2 where none of the 554# whitespace-separated words in $1 is a substring. 555not-containing = \ 556 $(strip $(filter-out $(call containing,$1,$2),$2)) 557 558# Return a list of all string elements that are duplicated in $1. 559dups = \ 560 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 561 $(words $(filter $v, $1))), $v))) 562 563# String equals 564equals = \ 565 $(and $(findstring $(strip $1),$(strip $2)),\ 566 $(findstring $(strip $2),$(strip $1))) 567 568# Remove a whole list of prefixes 569# $1 - List of prefixes 570# $2 - List of elements to process 571remove-prefixes = \ 572 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 573 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 574 575# Convert the string given to upper case, without any $(shell) 576# Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html 577uppercase_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 \ 578 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z 579 580uppercase_internal = \ 581 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \ 582 $(wordlist 2, $(words $1), $1), $2)), $2) 583 584# Convert a string to upper case. Works only on a-z. 585# $1 - The string to convert 586uppercase = \ 587 $(strip \ 588 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \ 589 $(uppercase_result) \ 590 ) 591 592################################################################################ 593 594ifneq ($(DISABLE_CACHE_FIND), true) 595 # In Cygwin, finds are very costly, both because of expensive forks and because 596 # of bad file system caching. Find is used extensively in $(shell) commands to 597 # find source files. This makes rerunning make with no or few changes rather 598 # expensive. To speed this up, these two macros are used to cache the results 599 # of simple find commands for reuse. 600 # 601 # Runs a find and stores both the directories where it was run and the results. 602 # This macro can be called multiple times to add to the cache. Only finds files 603 # with no filters. 604 # 605 # Needs to be called with $(eval ) 606 # 607 # Even if the performance benifit is negligible on other platforms, keep the 608 # functionality active unless explicitly disabled to exercise it more. 609 # 610 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 611 FIND_CACHE_DIRS := 612 # Param 1 - Dirs to find in 613 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 614 define FillCacheFind 615 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 616 # since filter out will then return empty. 617 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 618 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 619 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 620 # Remove any trailing slash from dirs in the cache dir list 621 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 622 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 623 endif 624 endef 625 626 # Mimics find by looking in the cache if all of the directories have been cached. 627 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 628 # cache is deactivated. 629 # 630 # $1 can be either a directory or a file. If it's a directory, make 631 # sure we have exactly one trailing slash before the wildcard. 632 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 633 # 634 # Param 1 - Dirs to find in 635 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 636 define CacheFind 637 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 638 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 639 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 640 endef 641 642else 643 # If CacheFind is disabled, just run the find command. 644 # Param 1 - Dirs to find in 645 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 646 define CacheFind 647 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 648 endef 649endif 650 651################################################################################ 652 653define AddFileToCopy 654 # Helper macro for SetupCopyFiles 655 # 1 : Source file 656 # 2 : Dest file 657 # 3 : Variable to add targets to 658 # 4 : Macro to call for copy operation 659 $2: $1 660 $$(call LogInfo, Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@)) 661 $$($$(strip $4)) 662 663 $3 += $2 664endef 665 666# Returns the value of the first argument 667identity = \ 668 $(strip $1) 669 670# Setup make rules for copying files, with an option to do more complex 671# processing instead of copying. 672# 673# Parameter 1 is the name of the rule. This name is used as variable prefix, 674# and the targets generated are listed in a variable by that name. 675# 676# Remaining parameters are named arguments. These include: 677# SRC : Source root dir (defaults to dir of first file) 678# DEST : Dest root dir 679# FILES : List of files to copy with absolute paths, or path relative to SRC. 680# Must be in SRC. 681# FLATTEN : Set to flatten the directory structure in the DEST dir. 682# MACRO : Optionally override the default macro used for making the copy. 683# Default is 'install-file' 684# NAME_MACRO : Optionally supply a macro that rewrites the target file name 685# based on the source file name 686SetupCopyFiles = $(NamedParamsMacroTemplate) 687define SetupCopyFilesBody 688 689 ifeq ($$($1_MACRO), ) 690 $1_MACRO := install-file 691 endif 692 693 # Default SRC to the dir of the first file. 694 ifeq ($$($1_SRC), ) 695 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 696 endif 697 698 ifeq ($$($1_NAME_MACRO), ) 699 $1_NAME_MACRO := identity 700 endif 701 702 # Remove any trailing slash from SRC and DEST 703 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 704 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 705 706 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 707 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 708 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \ 709 $1, $$($1_MACRO)))) 710 711endef 712 713################################################################################ 714# ShellQuote 715# 716# Quotes a string with single quotes and replaces single quotes with '\'' so 717# that the contents survives being given to the shell. 718 719ShellQuote = \ 720 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 721 722################################################################################ 723# Write to and read from file 724 725# Param 1 - File to read 726ReadFile = \ 727 $(shell $(CAT) $1) 728 729# Param 1 - Text to write 730# Param 2 - File to write to 731ifeq ($(HAS_FILE_FUNCTION), true) 732 WriteFile = \ 733 $(file >$2,$(strip $1)) 734else 735 # Use printf to get consistent behavior on all platforms. 736 WriteFile = \ 737 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 738endif 739 740################################################################################ 741# DependOnVariable 742# 743# This macro takes a variable name and puts the value in a file only if the 744# value has changed since last. The name of the file is returned. This can be 745# used to create rule dependencies on make variable values. The following 746# example would get rebuilt if the value of SOME_VAR was changed: 747# 748# path/to/some-file: $(call DependOnVariable, SOME_VAR) 749# echo $(SOME_VAR) > $@ 750# 751# Note that leading and trailing white space in the value is ignored. 752# 753 754# Defines the sub directory structure to store variable value file in 755DependOnVariableDirName = \ 756 $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \ 757 $(subst $(SRC_ROOT)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 758 $(firstword $(MAKEFILE_LIST)), \ 759 $(CURDIR)/$(firstword $(MAKEFILE_LIST)))))) 760 761# Defines the name of the file to store variable value in. Generates a name 762# unless parameter 2 is given. 763# Param 1 - Name of variable 764# Param 2 - (optional) name of file to store value in 765DependOnVariableFileName = \ 766 $(strip $(if $(strip $2), $2, \ 767 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 768 769# Does the actual work with parameters stripped. 770# If the file exists AND the contents is the same as the variable, do nothing 771# else print a new file. 772# Always returns the name of the file where the value was printed. 773# Param 1 - Name of variable 774# Param 2 - (optional) name of file to store value in 775DependOnVariableHelper = \ 776 $(strip \ 777 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 778 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 779 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 780 $(if $(findstring $(LOG_LEVEL), trace), \ 781 $(info NewVariable $1: >$(strip $($1))<) \ 782 $(info OldVariable $1: >$(strip $($1_old))<)) \ 783 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \ 784 $(call DependOnVariableFileName, $1, $2))) \ 785 $(call DependOnVariableFileName, $1, $2) \ 786 ) 787 788# Main macro 789# Param 1 - Name of variable 790# Param 2 - (optional) name of file to store value in 791DependOnVariable = \ 792 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 793 794# LogCmdlines is only intended to be used by ExecuteWithLog 795ifeq ($(LOG_CMDLINES), true) 796 LogCmdlines = $(info $(strip $1)) 797else 798 LogCmdlines = 799endif 800 801################################################################################ 802# ExecuteWithLog will run a command and log the output appropriately. This is 803# meant to be used by commands that do "real" work, like a compilation. 804# The output is stored in a specified log file, which is displayed at the end 805# of the build in case of failure. The command line itself is stored in a file, 806# and also logged to stdout if the LOG=cmdlines option has been given. 807# 808# Param 1 - The path to base the name of the log file / command line file on 809# Param 2 - The command to run 810ExecuteWithLog = \ 811 $(call LogCmdlines, Exececuting: [$(strip $2)]) \ 812 $(call WriteFile, $2, $(strip $1).cmdline) \ 813 ( ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \ 814 ( exitcode=$(DOLLAR)? && \ 815 $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(BUILD_OUTPUT)/%,%,$(strip $1))).log && \ 816 exit $(DOLLAR)exitcode ) ) && wait ) 817 818################################################################################ 819# Find lib dir for module 820# Param 1 - module name 821ifeq ($(OPENJDK_TARGET_OS_TYPE), unix) 822 FindLibDirForModule = \ 823 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)$(OPENJDK_TARGET_CPU_LIBDIR) 824else 825 FindLibDirForModule = \ 826 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 827endif 828 829################################################################################ 830# Return a string suitable for use after a -classpath or -modulepath option. It 831# will be correct and safe to use on all platforms. Arguments are given as space 832# separate classpath entries. Safe for multiple nested calls. 833# param 1 : A space separated list of classpath entries 834# The surrounding strip is needed to keep additional whitespace out 835PathList = \ 836 "$(subst $(SPACE),$(PATH_SEP),$(strip $(subst $(DQUOTE),,$1)))" 837 838################################################################################ 839# Check if a specified hotspot variant is being built, or at least one of a 840# list of variants. Will return 'true' or 'false'. 841# $1 - the variant to test for 842check-jvm-variant = \ 843 $(strip \ 844 $(if $(filter-out $(VALID_JVM_VARIANTS), $1), \ 845 $(error Internal error: Invalid variant tested: $1)) \ 846 $(if $(filter $1, $(JVM_VARIANTS)), true, false)) 847 848################################################################################ 849# Converts a space separated list to a comma separated list. 850# 851# Replacing double-comma with a single comma is to workaround the issue with 852# some version of make on windows that doesn't substitute spaces with one comma 853# properly. 854CommaList = \ 855 $(strip \ 856 $(subst $(COMMA)$(COMMA),$(COMMA),$(subst $(SPACE),$(COMMA),$(strip $1))) \ 857 ) 858 859################################################################################ 860 861# Hook to include the corresponding custom file, if present. 862$(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 863 864endif # _MAKEBASE_GMK 865