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