MakeBase.gmk revision 1410:e805c9330c7a
1# 2# Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved. 3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4# 5# This code is free software; you can redistribute it and/or modify it 6# under the terms of the GNU General Public License version 2 only, as 7# published by the Free Software Foundation. Oracle designates this 8# particular file as subject to the "Classpath" exception as provided 9# by Oracle in the LICENSE file that accompanied this code. 10# 11# This code is distributed in the hope that it will be useful, but WITHOUT 12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14# version 2 for more details (a copy is included in the LICENSE file that 15# accompanied this code). 16# 17# You should have received a copy of the GNU General Public License version 18# 2 along with this work; if not, write to the Free Software Foundation, 19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20# 21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22# or visit www.oracle.com if you need additional information or have any 23# questions. 24# 25 26################################################################ 27# 28# Setup common utility functions. 29# 30################################################################ 31 32ifndef _MAKEBASE_GMK 33_MAKEBASE_GMK := 1 34 35ifeq ($(wildcard $(SPEC)),) 36 $(error MakeBase.gmk needs SPEC set to a proper spec.gmk) 37endif 38 39 40############################## 41# Functions 42############################## 43 44 45### Functions for timers 46 47# Store the build times in this directory. 48BUILDTIMESDIR=$(OUTPUT_ROOT)/make-support/build-times 49 50# Record starting time for build of a sub repository. 51define RecordStartTime 52 $(MKDIR) -p $(BUILDTIMESDIR) 53 $(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) 54 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$(strip $1)_human_readable 55endef 56 57# Record ending time and calculate the difference and store it in a 58# easy to read format. Handles builds that cross midnight. Expects 59# that a build will never take 24 hours or more. 60define RecordEndTime 61 $(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) 62 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)_human_readable 63 $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$(strip $1)` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$(strip $1)` $1 | \ 64 $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ 65 M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ 66 > $(BUILDTIMESDIR)/build_time_diff_$(strip $1) 67endef 68 69# Hook to be called when starting to execute a top-level target 70define TargetEnter 71 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 72 $(call RecordStartTime,$(patsubst %-only,%,$@)) 73endef 74 75# Hook to be called when finish executing a top-level target 76define TargetExit 77 $(call RecordEndTime,$(patsubst %-only,%,$@)) 78 $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ 79 "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" 80endef 81 82################################################################################ 83# This macro translates $ into \$ to protect the $ from expansion in the shell. 84# To make this macro resilient against already escaped strings, first remove 85# any present escapes before escaping so that no double escapes are added. 86EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 87 88################################################################################ 89# This macro translates $ into $$ to protect the string from make itself. 90DoubleDollar = $(subst $$,$$$$,$(strip $1)) 91 92################################################################################ 93 94# If the variable that you want to send to stdout for piping into a file or otherwise, 95# is potentially long, for example the a list of file paths, eg a list of all package directories. 96# Then you need to use ListPathsSafely, which optimistically splits the output into several shell 97# calls as well as use compression on recurrent file paths segments, to get around the potential 98# command line length problem that exists in cygwin and other shells. 99compress_pre:=$(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-pre-compress.incl)) 100compress_post:=$(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-post-compress.incl)) 101compress_paths=$(compress_pre)\ 102$(subst $(SRC_ROOT),X97,\ 103$(subst $(OUTPUT_ROOT),X98,\ 104$(subst X,X00,\ 105$(subst $(SPACE),\n,$(strip $1)))))\ 106$(compress_post) 107 108decompress_paths=$(SED) -f $(SRC_ROOT)/make/common/support/ListPathsSafely-uncompress.sed -e 's|X99|\\n|g' \ 109 -e 's|X98|$(OUTPUT_ROOT)|g' -e 's|X97|$(SRC_ROOT)|g' \ 110 -e 's|X00|X|g' | tr '\n' '$2' 111 112define ListPathsSafely_If 113 $(if $(word $3,$($1)),$(eval $1_LPS$3:=$(call compress_paths,$(wordlist $3,$4,$($1))))) 114endef 115 116define ListPathsSafely_Printf 117 $(if $(strip $($1_LPS$4)),$(if $(findstring $(LOG_LEVEL),trace),,@)printf \ 118 -- "$(strip $(call EscapeDollar, $($1_LPS$4)))\n" | $(decompress_paths) $3) 119endef 120 121# Receipt example: 122# rm -f thepaths 123# $(call ListPathsSafely,THEPATHS,\n, >> thepaths) 124# The \n argument means translate spaces into \n 125# if instead , , (a space) is supplied, then spaces remain spaces. 126define ListPathsSafely 127 $(if $(word 16001,$($1)),$(error Cannot list safely more than 16000 paths. $1 has $(words $($1)) paths!)) 128 $(ECHO) $(LOG_DEBUG) Writing $(words $($1)) paths to '$3' 129 $(call ListPathsSafely_If,$1,$2,1,250) 130 $(call ListPathsSafely_If,$1,$2,251,500) 131 $(call ListPathsSafely_If,$1,$2,501,750) 132 $(call ListPathsSafely_If,$1,$2,751,1000) 133 134 $(call ListPathsSafely_If,$1,$2,1001,1250) 135 $(call ListPathsSafely_If,$1,$2,1251,1500) 136 $(call ListPathsSafely_If,$1,$2,1501,1750) 137 $(call ListPathsSafely_If,$1,$2,1751,2000) 138 139 $(call ListPathsSafely_If,$1,$2,2001,2250) 140 $(call ListPathsSafely_If,$1,$2,2251,2500) 141 $(call ListPathsSafely_If,$1,$2,2501,2750) 142 $(call ListPathsSafely_If,$1,$2,2751,3000) 143 144 $(call ListPathsSafely_If,$1,$2,3001,3250) 145 $(call ListPathsSafely_If,$1,$2,3251,3500) 146 $(call ListPathsSafely_If,$1,$2,3501,3750) 147 $(call ListPathsSafely_If,$1,$2,3751,4000) 148 149 $(call ListPathsSafely_If,$1,$2,4001,4250) 150 $(call ListPathsSafely_If,$1,$2,4251,4500) 151 $(call ListPathsSafely_If,$1,$2,4501,4750) 152 $(call ListPathsSafely_If,$1,$2,4751,5000) 153 154 $(call ListPathsSafely_If,$1,$2,5001,5250) 155 $(call ListPathsSafely_If,$1,$2,5251,5500) 156 $(call ListPathsSafely_If,$1,$2,5501,5750) 157 $(call ListPathsSafely_If,$1,$2,5751,6000) 158 159 $(call ListPathsSafely_If,$1,$2,6001,6250) 160 $(call ListPathsSafely_If,$1,$2,6251,6500) 161 $(call ListPathsSafely_If,$1,$2,6501,6750) 162 $(call ListPathsSafely_If,$1,$2,6751,7000) 163 164 $(call ListPathsSafely_If,$1,$2,7001,7250) 165 $(call ListPathsSafely_If,$1,$2,7251,7500) 166 $(call ListPathsSafely_If,$1,$2,7501,7750) 167 $(call ListPathsSafely_If,$1,$2,7751,8000) 168 169 $(call ListPathsSafely_If,$1,$2,8001,8250) 170 $(call ListPathsSafely_If,$1,$2,8251,8500) 171 $(call ListPathsSafely_If,$1,$2,8501,8750) 172 $(call ListPathsSafely_If,$1,$2,8751,9000) 173 174 $(call ListPathsSafely_If,$1,$2,9001,9250) 175 $(call ListPathsSafely_If,$1,$2,9251,9500) 176 $(call ListPathsSafely_If,$1,$2,9501,9750) 177 $(call ListPathsSafely_If,$1,$2,9751,10000) 178 179 $(call ListPathsSafely_If,$1,$2,10001,10250) 180 $(call ListPathsSafely_If,$1,$2,10251,10500) 181 $(call ListPathsSafely_If,$1,$2,10501,10750) 182 $(call ListPathsSafely_If,$1,$2,10751,11000) 183 184 $(call ListPathsSafely_If,$1,$2,11001,11250) 185 $(call ListPathsSafely_If,$1,$2,11251,11500) 186 $(call ListPathsSafely_If,$1,$2,11501,11750) 187 $(call ListPathsSafely_If,$1,$2,11751,12000) 188 189 $(call ListPathsSafely_If,$1,$2,12001,12250) 190 $(call ListPathsSafely_If,$1,$2,12251,12500) 191 $(call ListPathsSafely_If,$1,$2,12501,12750) 192 $(call ListPathsSafely_If,$1,$2,12751,13000) 193 194 $(call ListPathsSafely_If,$1,$2,13001,13250) 195 $(call ListPathsSafely_If,$1,$2,13251,13500) 196 $(call ListPathsSafely_If,$1,$2,13501,13750) 197 $(call ListPathsSafely_If,$1,$2,13751,14000) 198 199 $(call ListPathsSafely_If,$1,$2,14001,14250) 200 $(call ListPathsSafely_If,$1,$2,14251,14500) 201 $(call ListPathsSafely_If,$1,$2,14501,14750) 202 $(call ListPathsSafely_If,$1,$2,14751,15000) 203 204 $(call ListPathsSafely_If,$1,$2,15001,15250) 205 $(call ListPathsSafely_If,$1,$2,15251,15500) 206 $(call ListPathsSafely_If,$1,$2,15501,15750) 207 $(call ListPathsSafely_If,$1,$2,15751,16000) 208 209 $(call ListPathsSafely_Printf,$1,$2,$3,1) 210 $(call ListPathsSafely_Printf,$1,$2,$3,251) 211 $(call ListPathsSafely_Printf,$1,$2,$3,501) 212 $(call ListPathsSafely_Printf,$1,$2,$3,751) 213 214 $(call ListPathsSafely_Printf,$1,$2,$3,1001) 215 $(call ListPathsSafely_Printf,$1,$2,$3,1251) 216 $(call ListPathsSafely_Printf,$1,$2,$3,1501) 217 $(call ListPathsSafely_Printf,$1,$2,$3,1751) 218 219 $(call ListPathsSafely_Printf,$1,$2,$3,2001) 220 $(call ListPathsSafely_Printf,$1,$2,$3,2251) 221 $(call ListPathsSafely_Printf,$1,$2,$3,2501) 222 $(call ListPathsSafely_Printf,$1,$2,$3,2751) 223 224 $(call ListPathsSafely_Printf,$1,$2,$3,3001) 225 $(call ListPathsSafely_Printf,$1,$2,$3,3251) 226 $(call ListPathsSafely_Printf,$1,$2,$3,3501) 227 $(call ListPathsSafely_Printf,$1,$2,$3,3751) 228 229 $(call ListPathsSafely_Printf,$1,$2,$3,4001) 230 $(call ListPathsSafely_Printf,$1,$2,$3,4251) 231 $(call ListPathsSafely_Printf,$1,$2,$3,4501) 232 $(call ListPathsSafely_Printf,$1,$2,$3,4751) 233 234 $(call ListPathsSafely_Printf,$1,$2,$3,5001) 235 $(call ListPathsSafely_Printf,$1,$2,$3,5251) 236 $(call ListPathsSafely_Printf,$1,$2,$3,5501) 237 $(call ListPathsSafely_Printf,$1,$2,$3,5751) 238 239 $(call ListPathsSafely_Printf,$1,$2,$3,6001) 240 $(call ListPathsSafely_Printf,$1,$2,$3,6251) 241 $(call ListPathsSafely_Printf,$1,$2,$3,6501) 242 $(call ListPathsSafely_Printf,$1,$2,$3,6751) 243 244 $(call ListPathsSafely_Printf,$1,$2,$3,7001) 245 $(call ListPathsSafely_Printf,$1,$2,$3,7251) 246 $(call ListPathsSafely_Printf,$1,$2,$3,7501) 247 $(call ListPathsSafely_Printf,$1,$2,$3,7751) 248 249 $(call ListPathsSafely_Printf,$1,$2,$3,8001) 250 $(call ListPathsSafely_Printf,$1,$2,$3,8251) 251 $(call ListPathsSafely_Printf,$1,$2,$3,8501) 252 $(call ListPathsSafely_Printf,$1,$2,$3,8751) 253 254 $(call ListPathsSafely_Printf,$1,$2,$3,9001) 255 $(call ListPathsSafely_Printf,$1,$2,$3,9251) 256 $(call ListPathsSafely_Printf,$1,$2,$3,9501) 257 $(call ListPathsSafely_Printf,$1,$2,$3,9751) 258 259 $(call ListPathsSafely_Printf,$1,$2,$3,10001) 260 $(call ListPathsSafely_Printf,$1,$2,$3,10251) 261 $(call ListPathsSafely_Printf,$1,$2,$3,10501) 262 $(call ListPathsSafely_Printf,$1,$2,$3,10751) 263 264 $(call ListPathsSafely_Printf,$1,$2,$3,11001) 265 $(call ListPathsSafely_Printf,$1,$2,$3,11251) 266 $(call ListPathsSafely_Printf,$1,$2,$3,11501) 267 $(call ListPathsSafely_Printf,$1,$2,$3,11751) 268 269 $(call ListPathsSafely_Printf,$1,$2,$3,12001) 270 $(call ListPathsSafely_Printf,$1,$2,$3,12251) 271 $(call ListPathsSafely_Printf,$1,$2,$3,12501) 272 $(call ListPathsSafely_Printf,$1,$2,$3,12751) 273 274 $(call ListPathsSafely_Printf,$1,$2,$3,13001) 275 $(call ListPathsSafely_Printf,$1,$2,$3,13251) 276 $(call ListPathsSafely_Printf,$1,$2,$3,13501) 277 $(call ListPathsSafely_Printf,$1,$2,$3,13751) 278 279 $(call ListPathsSafely_Printf,$1,$2,$3,14001) 280 $(call ListPathsSafely_Printf,$1,$2,$3,14251) 281 $(call ListPathsSafely_Printf,$1,$2,$3,14501) 282 $(call ListPathsSafely_Printf,$1,$2,$3,14751) 283 284 $(call ListPathsSafely_Printf,$1,$2,$3,15001) 285 $(call ListPathsSafely_Printf,$1,$2,$3,15251) 286 $(call ListPathsSafely_Printf,$1,$2,$3,15501) 287 $(call ListPathsSafely_Printf,$1,$2,$3,15751) 288endef 289 290define ListPathsSafelyNow_IfPrintf 291 ifneq (,$$(word $4,$$($1))) 292 $$(eval $1_LPS$4:=$$(call compress_paths,$$(wordlist $4,$5,$$($1)))) 293 $$(shell printf -- "$$(strip $$($1_LPS$4))\n" | $(decompress_paths) $3) 294 endif 295endef 296 297# And an non-receipt version: 298define ListPathsSafelyNow 299 ifneq (,$$(word 10001,$$($1))) 300 $$(error Cannot list safely more than 10000 paths. $1 has $$(words $$($1)) paths!) 301 endif 302 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1,250) 303 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,251,500) 304 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,501,750) 305 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,751,1000) 306 307 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1001,1250) 308 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1251,1500) 309 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1501,1750) 310 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1751,2000) 311 312 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2001,2250) 313 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2251,2500) 314 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2501,2750) 315 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2751,3000) 316 317 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3001,3250) 318 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3251,3500) 319 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3501,3750) 320 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3751,4000) 321 322 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4001,4250) 323 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4251,4500) 324 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4501,4750) 325 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4751,5000) 326 327 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5001,5250) 328 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5251,5500) 329 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5501,5750) 330 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5751,6000) 331 332 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6001,6250) 333 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6251,6500) 334 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6501,6750) 335 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6751,7000) 336 337 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7001,7250) 338 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7251,7500) 339 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7501,7750) 340 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7751,8000) 341 342 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8001,8250) 343 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8251,8500) 344 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8501,8750) 345 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8751,9000) 346 347 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9001,9250) 348 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9251,9500) 349 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9501,9750) 350 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9751,10000) 351 352endef 353 354# The source tips can come from the Mercurial repository, or in the files 355# $(HGTIP_FILENAME) which contains the tip but is also positioned in the same 356# directory as the original $(HGDIR) directory. 357# These should not be := assignments, only used from the root Makefile. 358HG_VERSION = $(shell $(HG) version 2> /dev/null) 359HG_DIRECTORY=.hg 360HGTIP_FILENAME=.hgtip 361HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO 362REPO_LIST = $(patsubst ./%,%,$(patsubst %/,%,$(sort $(dir \ 363 $(shell $(CD) $(SRC_ROOT) ; ( $(LS) -d $(HG_SEARCH:%/REPO=%/$(HG_DIRECTORY)) ; \ 364 $(LS) $(HG_SEARCH:%/REPO=%/$(HGTIP_FILENAME)) ) \ 365 2> /dev/null))))) 366 367# Emit the repo:tip pairs to $@ 368define GetSourceTips 369 $(CD) $(SRC_ROOT) ; \ 370 for i in $(REPO_LIST) IGNORE ; do \ 371 if [ "$${i}" = "IGNORE" ] ; then \ 372 continue; \ 373 elif [ -d $${i}/$(HG_DIRECTORY) -a "$(HG_VERSION)" != "" ] ; then \ 374 $(PRINTF) " %s:%s" \ 375 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \ 376 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \ 377 $(PRINTF) " %s:%s" \ 378 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \ 379 fi; \ 380 done >> $@ 381 $(PRINTF) "\n" >> $@ 382endef 383 384# Create the HGTIP_FILENAME file. Called from jdk/make/closed/bundles.gmk 385define CreateHgTip 386 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \ 387 $(ECHO) $1/$(HGTIP_FILENAME) 388endef 389 390define SetupLogging 391 ifeq ($$(LOG_LEVEL), trace) 392 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 393 # For each target executed, will print 394 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 395 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 396 # (and causing a crash on Cygwin). 397 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 398 # Only use time if it's GNU time which supports format and output file. 399 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 400 SHELL := $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 401 endif 402 # Never remove warning messages; this is just for completeness 403 LOG_WARN := 404 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 405 LOG_INFO := 406 else 407 LOG_INFO := > /dev/null 408 endif 409 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 410 LOG_DEBUG := 411 else 412 LOG_DEBUG := > /dev/null 413 endif 414 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 415 LOG_TRACE := 416 else 417 LOG_TRACE := > /dev/null 418 endif 419endef 420 421# Make sure logging is setup for everyone that includes MakeBase.gmk. 422$(eval $(call SetupLogging)) 423 424################################################################################ 425# Creates a sequence of increasing numbers (inclusive). 426# Param 1 - starting number 427# Param 2 - ending number 428sequence = \ 429 $(wordlist $1, $2, $(strip \ 430 $(eval SEQUENCE_COUNT :=) \ 431 $(call _sequence-do,$(strip $2)))) 432 433_sequence-do = \ 434 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 435 $(eval SEQUENCE_COUNT += .) \ 436 $(words $(SEQUENCE_COUNT)) \ 437 $(call _sequence-do,$1)) 438 439################################################################################ 440 441MAX_PARAMS := 30 442PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 443 444# Template for creating a macro taking named parameters. To use it, assign the 445# template to a variable with the name you want for your macro, using '=' 446# assignment. Then define a macro body with the suffix "Body". The Body macro 447# should take 1 parameter which should be a unique string for that invocation 448# of the macro. 449# Ex: 450# SetupFoo = $(NamedParamsMacroTemplate) 451# define SetupFooBody 452# # do something 453# # access parameters as $$($1_BAR) 454# endef 455# Call it like this 456# $(eval $(call SetupFoo, BUILD_SOMETHING, \ 457# BAR := some parameter value, \ 458# )) 459define NamedParamsMacroTemplate 460 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 461 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 462 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 463 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 464 $(strip $1)_$(strip $($i)))$(NEWLINE)) 465 # Debug print all named parameter names and values 466 $(if $(findstring $(LOG_LEVEL),debug trace), \ 467 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 468 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 469 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 470 471 $(if $(DEBUG_$(strip $1)), 472 $(info -------- <<< Begin expansion of $(strip $1)) \ 473 $(info $(call $(0)Body,$(strip $1))) \ 474 $(info -------- >>> End expansion of $(strip $1)) \ 475 ) 476 477 $(call $(0)Body,$(strip $1)) 478endef 479 480################################################################################ 481# Make directory without forking mkdir if not needed 482MakeDir = \ 483 $(strip $(if $(subst $(wildcard $1 $2 $3 $4 $5 $6 $7 $8 $9),,$(strip $1 $2 $3 $4 $5 $6 $7 $8 $9)),\ 484 $(shell $(MKDIR) -p $1 $2 $3 $4 $5 $6 $7 $8 $9))) 485 486################################################################################ 487 488ifeq ($(OPENJDK_TARGET_OS),solaris) 489 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 490 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 491 # name of the target file differs from the source file, rename after copy. 492 # If the source and target parent directories are the same, recursive copy doesn't work 493 # so we fall back on regular copy, which isn't preserving symlinks. 494 define install-file 495 $(MKDIR) -p '$(@D)' 496 $(RM) '$@' 497 if [ "$(@D)" != "$(<D)" ]; then \ 498 $(CP) -f -r -P '$<' '$(@D)'; \ 499 if [ "$(@F)" != "$(<F)" ]; then \ 500 $(MV) '$(@D)/$(<F)' '$@'; \ 501 fi; \ 502 else \ 503 if [ -L '$<' ]; then \ 504 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 505 exit 1; \ 506 fi; \ 507 $(CP) -f '$<' '$@'; \ 508 fi 509 endef 510else ifeq ($(OPENJDK_TARGET_OS),macosx) 511 # On mac, extended attributes sometimes creep into the source files, which may later 512 # cause the creation of ._* files which confuses testing. Clear these with xattr if 513 # set. Some files get their write permissions removed after being copied to the 514 # output dir. When these are copied again to images, xattr would fail. By only clearing 515 # attributes when they are present, failing on this is avoided. 516 define install-file 517 $(MKDIR) -p '$(@D)' 518 $(CP) -fRP '$<' '$@' 519 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 520 endef 521else 522 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 523 # significantly. 524 define install-file 525 $(MKDIR) -p '$(@D)' && $(CP) -fP '$<' '$@' 526 endef 527endif 528 529################################################################################ 530# Convenience functions for working around make's limitations with $(filter ). 531containing = \ 532 $(strip $(foreach v,$(strip $2),$(if $(findstring $(strip $1),$v),$v))) 533not-containing = \ 534 $(strip $(foreach v,$(strip $2),$(if $(findstring $(strip $1),$v),,$v))) 535 536# Filter out duplicate sub strings while preserving order. Keeps the first occurance. 537uniq = \ 538 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 539 540# Return a list of all string elements that are duplicated in $1. 541dups = \ 542 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 543 $(words $(filter $v, $1))), $v))) 544 545# String equals 546equals = \ 547 $(and $(findstring $(strip $1),$(strip $2)),\ 548 $(findstring $(strip $2),$(strip $1))) 549 550################################################################################ 551 552ifneq ($(DISABLE_CACHE_FIND), true) 553 # In Cygwin, finds are very costly, both because of expensive forks and because 554 # of bad file system caching. Find is used extensively in $(shell) commands to 555 # find source files. This makes rerunning make with no or few changes rather 556 # expensive. To speed this up, these two macros are used to cache the results 557 # of simple find commands for reuse. 558 # 559 # Runs a find and stores both the directories where it was run and the results. 560 # This macro can be called multiple times to add to the cache. Only finds files 561 # with no filters. 562 # 563 # Needs to be called with $(eval ) 564 # 565 # Even if the performance benifit is negligible on other platforms, keep the 566 # functionality active unless explicitly disabled to exercise it more. 567 # 568 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 569 FIND_CACHE_DIRS := 570 # Param 1 - Dirs to find in 571 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 572 define FillCacheFind 573 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 574 # since filter out will then return empty. 575 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 576 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 577 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 578 # Remove any trailing slash from dirs in the cache dir list 579 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 580 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 581 endif 582 endef 583 584 # Mimics find by looking in the cache if all of the directories have been cached. 585 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 586 # cache is deactivated. 587 # 588 # $1 can be either a directory or a file. If it's a directory, make 589 # sure we have exactly one trailing slash before the wildcard. 590 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 591 # 592 # Param 1 - Dirs to find in 593 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 594 define CacheFind 595 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 596 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 597 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 598 endef 599 600else 601 # If CacheFind is disabled, just run the find command. 602 # Param 1 - Dirs to find in 603 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 604 define CacheFind 605 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 606 endef 607endif 608 609################################################################################ 610 611define AddFileToCopy 612 # Helper macro for SetupCopyFiles 613 # 1 : Source file 614 # 2 : Dest file 615 # 3 : Variable to add targets to 616 # 4 : Macro to call for copy operation 617 $2: $1 618 $(ECHO) $(LOG_INFO) Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@) 619 $$($$(strip $4)) 620 621 $3 += $2 622endef 623 624# Setup make rules for copying files, with an option to do more complex 625# processing instead of copying. 626# 627# Parameter 1 is the name of the rule. This name is used as variable prefix, 628# and the targets generated are listed in a variable by that name. 629# 630# Remaining parameters are named arguments. These include: 631# SRC : Source root dir (defaults to dir of first file) 632# DEST : Dest root dir 633# FILES : List of files to copy with absolute paths, or path relative to SRC. 634# Must be in SRC. 635# FLATTEN : Set to flatten the directory structure in the DEST dir. 636# MACRO : Optionally override the default macro used for making the copy. 637# Default is 'install-file' 638SetupCopyFiles = $(NamedParamsMacroTemplate) 639define SetupCopyFilesBody 640 641 ifeq ($$($1_MACRO), ) 642 $1_MACRO := install-file 643 endif 644 645 # Default SRC to the dir of the first file. 646 ifeq ($$($1_SRC), ) 647 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 648 endif 649 650 # Remove any trailing slash from SRC 651 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 652 653 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 654 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 655 $$($1_DEST)/$$(if $$($1_FLATTEN),$$(notdir $$f),$$f), $1, $$($1_MACRO)))) 656 657endef 658 659################################################################################ 660# ShellQuote 661# 662# Quotes a string with single quotes and replaces single quotes with '\'' so 663# that the contents survives being given to the shell. 664 665ShellQuote = \ 666 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 667 668################################################################################ 669# Write to and read from file 670 671# Param 1 - File to read 672ReadFile = \ 673 $(shell $(CAT) $1) 674 675# Param 1 - Text to write 676# Param 2 - File to write to 677# Use printf to get consistent behavior on all platforms. 678WriteFile = \ 679 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 680 681################################################################################ 682# DependOnVariable 683# 684# This macro takes a variable name and puts the value in a file only if the 685# value has changed since last. The name of the file is returned. This can be 686# used to create rule dependencies on make variable values. The following 687# example would get rebuilt if the value of SOME_VAR was changed: 688# 689# path/to/some-file: $(call DependOnVariable, SOME_VAR) 690# echo $(SOME_VAR) > $@ 691# 692# Note that leading and trailing white space in the value is ignored. 693# 694 695# Defines the sub directory structure to store variable value file in 696DependOnVariableDirName = \ 697 $(strip $(subst $(SRC_ROOT)/,,\ 698 $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 699 $(firstword $(MAKEFILE_LIST)), \ 700 $(CURDIR)/$(firstword $(MAKEFILE_LIST))))) 701 702# Defines the name of the file to store variable value in. Generates a name 703# unless parameter 2 is given. 704# Param 1 - Name of variable 705# Param 2 - (optional) name of file to store value in 706DependOnVariableFileName = \ 707 $(strip $(if $(strip $2), $2, \ 708 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 709 710# Does the actual work with parameters stripped. 711# If the file exists AND the contents is the same as the variable, do nothing 712# else print a new file. 713# Always returns the name of the file where the value was printed. 714# Param 1 - Name of variable 715# Param 2 - (optional) name of file to store value in 716DependOnVariableHelper = \ 717 $(strip $(if $(and $(wildcard $(call DependOnVariableFileName, $1, $2)),\ 718 $(call equals, $(strip $($1)), \ 719 $(call ReadFile, $(call DependOnVariableFileName, $1, $2)))),,\ 720 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 721 $(if $(findstring $(LOG_LEVEL), trace), \ 722 $(info Variable $1: >$(strip $($1))<) \ 723 $(info File: >$(call ReadFile, $(call DependOnVariableFileName, $1, $2))<)) \ 724 $(call WriteFile, $($1), $(call DependOnVariableFileName, $1, $2))) \ 725 $(call DependOnVariableFileName, $1, $2)) 726 727# Main macro 728# Param 1 - Name of variable 729# Param 2 - (optional) name of file to store value in 730DependOnVariable = \ 731 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 732 733################################################################################ 734 735# Hook to include the corresponding custom file, if present. 736$(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 737 738endif # _MAKEBASE_GMK 739