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 # 1: List of directories to create
 478 MakeDir = \
 479     $(strip \
 480         $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, $(if $(wildcard $d), , \
 481             "$(call DecodeSpace, $d)")))) \
 482         $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \
 483     )
 484 
 485 ################################################################################
 486 # Assign a variable only if it is empty
 487 # Param 1 - Variable to assign
 488 # Param 2 - Value to assign
 489 SetIfEmpty = \
 490     $(if $($(strip $1)),,$(eval $(strip $1) := $2))
 491 
 492 ################################################################################
 493 # All install-file and related macros automatically call DecodeSpace when needed.
 494 
 495 ifeq ($(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         $(call MakeDir, $(@D))
 503         $(RM) "$(call DecodeSpace, $@)"
 504         if [ "$(call DecodeSpace, $(dir $@))" != \
 505             "$(call DecodeSpace, $(dir $(call EncodeSpace, $<)))" ]; then \
 506           $(CP) -f -r -P "$(call DecodeSpace, $<)" "$(call DecodeSpace, $(@D))"; \
 507           if [ "$(call DecodeSpace, $(@F))" != \
 508               "$(call DecodeSpace, $(notdir $(call EncodeSpace, $(<))))" ]; then \
 509             $(MV) "$(call DecodeSpace, $(@D)/$(<F))" "$(call DecodeSpace, $@)"; \
 510           fi; \
 511         else \
 512           if [ -L "$(call DecodeSpace, $<)" ]; then \
 513             $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \
 514             exit 1; \
 515           fi; \
 516           $(CP) -f "$(call DecodeSpace, $<)" "$(call DecodeSpace, $@)"; \
 517         fi
 518   endef
 519 else ifeq ($(OPENJDK_TARGET_OS),macosx)
 520   # On mac, extended attributes sometimes creep into the source files, which may later
 521   # cause the creation of ._* files which confuses testing. Clear these with xattr if
 522   # set. Some files get their write permissions removed after being copied to the
 523   # output dir. When these are copied again to images, xattr would fail. By only clearing
 524   # attributes when they are present, failing on this is avoided.
 525   #
 526   # If copying a soft link to a directory, need to delete the target first to avoid
 527   # weird errors.
 528   define install-file
 529         $(call MakeDir, $(@D))
 530         $(RM) "$(call DecodeSpace, $@)"
 531         $(CP) -fRP "$(call DecodeSpace, $<)" "$(call DecodeSpace, $@)"
 532         if [ -n "`$(XATTR) -l "$(call DecodeSpace, $@)"`" ]; then $(XATTR) -c "$(call DecodeSpace, $@)"; fi
 533   endef
 534 else
 535   define install-file
 536         $(call MakeDir, $(@D))
 537         $(CP) -fP "$(call DecodeSpace, $<)" "$(call DecodeSpace, $@)"
 538   endef
 539 endif
 540 
 541 # Variant of install file that does not preserve symlinks
 542 define install-file-nolink
 543         $(call MakeDir, $(@D))
 544         $(CP) -f "$(call DecodeSpace, $<)" "$(call DecodeSpace, $@)"
 545 endef
 546 
 547 ################################################################################
 548 # Take two paths and return the path of the last common directory.
 549 # Ex: /foo/bar/baz, /foo/bar/banan -> /foo/bar
 550 #     foo/bar/baz, /foo/bar -> <empty>
 551 #
 552 # The x prefix is used to preserve the presence of the initial slash
 553 #
 554 # $1 - Path to compare
 555 # $2 - Other path to compare
 556 FindCommonPathPrefix = \
 557     $(patsubst x%,%,$(subst $(SPACE),/,$(strip \
 558         $(call FindCommonPathPrefixHelper, \
 559             $(subst /,$(SPACE),x$(strip $1)), $(subst /,$(SPACE),x$(strip $2))) \
 560     )))
 561 
 562 FindCommonPathPrefixHelper = \
 563     $(if $(call equals, $(firstword $1), $(firstword $2)), \
 564       $(firstword $1) \
 565       $(call FindCommonPathPrefixHelper, \
 566           $(wordlist 2, $(words $1), $1), $(wordlist 2, $(words $2), $2) \
 567       ) \
 568     )
 569 
 570 # Convert a partial path into as many directory levels of ../, removing
 571 # leading and following /.
 572 # Ex: foo/bar/baz/ -> ../../..
 573 #     foo/bar -> ../..
 574 #     /foo -> ..
 575 DirToDotDot = \
 576     $(subst $(SPACE),/,$(foreach d, $(subst /,$(SPACE),$1),..))
 577 
 578 # Computes the relative path from a directory to a file
 579 # $1 - File to compute the relative path to
 580 # $2 - Directory to compute the relative path from
 581 RelativePath = \
 582     $(eval $1_prefix := $(call FindCommonPathPrefix, $1, $2)) \
 583     $(eval $1_dotdots := $(call DirToDotDot, $(patsubst $($(strip $1)_prefix)/%, %, $2))) \
 584     $(eval $1_suffix := $(patsubst $($(strip $1)_prefix)/%, %, $1)) \
 585     $($(strip $1)_dotdots)/$($(strip $1)_suffix)
 586 
 587 ################################################################################
 588 # link-file-* works similarly to install-file but creates a symlink instead.
 589 # There are two versions, either creating a relative or an absolute link. Be
 590 # careful when using this on Windows since the symlink created is only valid in
 591 # the unix emulation environment.
 592 define link-file-relative
 593         $(call MakeDir, $(@D))
 594         $(RM) "$(call DecodeSpace, $@)"
 595         $(LN) -s "$(call DecodeSpace, $(call RelativePath, $<, $(@D)))" "$(call DecodeSpace, $@)"
 596 endef
 597 
 598 define link-file-absolute
 599         $(call MakeDir, $(@D))
 600         $(RM) "$(call DecodeSpace, $@)"
 601         $(LN) -s "$(call DecodeSpace, $<)" "$(call DecodeSpace, $@)"
 602 endef
 603 
 604 ################################################################################
 605 # Filter out duplicate sub strings while preserving order. Keeps the first occurance.
 606 uniq = \
 607     $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))
 608 
 609 # Returns all whitespace-separated words in $2 where at least one of the
 610 # whitespace-separated words in $1 is a substring.
 611 containing = \
 612     $(strip \
 613         $(foreach v,$(strip $2),\
 614           $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v)))))
 615 
 616 # Returns all whitespace-separated words in $2 where none of the
 617 # whitespace-separated words in $1 is a substring.
 618 not-containing = \
 619     $(strip $(filter-out $(call containing,$1,$2),$2))
 620 
 621 # Return a list of all string elements that are duplicated in $1.
 622 dups = \
 623     $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \
 624         $(words $(filter $v, $1))), $v)))
 625 
 626 # String equals
 627 equals = \
 628     $(and $(findstring $(strip $1),$(strip $2)),\
 629         $(findstring $(strip $2),$(strip $1)))
 630 
 631 # Remove a whole list of prefixes
 632 # $1 - List of prefixes
 633 # $2 - List of elements to process
 634 remove-prefixes = \
 635     $(strip $(if $1,$(patsubst $(firstword $1)%,%,\
 636       $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2))
 637 
 638 # Convert the string given to upper case, without any $(shell)
 639 # Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html
 640 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 \
 641     p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z
 642 
 643 uppercase_internal = \
 644   $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \
 645       $(wordlist 2, $(words $1), $1), $2)), $2)
 646 
 647 # Convert a string to upper case. Works only on a-z.
 648 # $1 - The string to convert
 649 uppercase = \
 650   $(strip \
 651     $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \
 652     $(uppercase_result) \
 653   )
 654 
 655 ################################################################################
 656 
 657 ifneq ($(DISABLE_CACHE_FIND), true)
 658   # In Cygwin, finds are very costly, both because of expensive forks and because
 659   # of bad file system caching. Find is used extensively in $(shell) commands to
 660   # find source files. This makes rerunning make with no or few changes rather
 661   # expensive. To speed this up, these two macros are used to cache the results
 662   # of simple find commands for reuse.
 663   #
 664   # Runs a find and stores both the directories where it was run and the results.
 665   # This macro can be called multiple times to add to the cache. Only finds files
 666   # with no filters.
 667   #
 668   # Files containing space will get spaces replaced with ? because GNU Make
 669   # cannot handle lists of files with space in them. By using ?, make will match
 670   # the wildcard to space in many situations so we don't need to replace back
 671   # to space on every use. While not a complete solution it does allow some uses
 672   # of CacheFind to function with spaces in file names, including for
 673   # SetupCopyFiles.
 674   #
 675   # Needs to be called with $(eval )
 676   #
 677   # Even if the performance benifit is negligible on other platforms, keep the
 678   # functionality active unless explicitly disabled to exercise it more.
 679   #
 680   # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable
 681   FIND_CACHE_DIRS :=
 682   # Param 1 - Dirs to find in
 683   # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
 684   define FillCacheFind
 685     # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty
 686     # since filter out will then return empty.
 687     FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\
 688         - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1)
 689     ifneq ($$(FIND_CACHE_NEW_DIRS), )
 690       # Remove any trailing slash from dirs in the cache dir list
 691       FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS))
 692       FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \
 693           \( -type f -o -type l \) $2 | $(TR) ' ' '?'))
 694     endif
 695   endef
 696 
 697   # Mimics find by looking in the cache if all of the directories have been cached.
 698   # Otherwise reverts to shell find. This is safe to call on all platforms, even if
 699   # cache is deactivated.
 700   #
 701   # $1 can be either a directory or a file. If it's a directory, make
 702   # sure we have exactly one trailing slash before the wildcard.
 703   # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless.
 704   #
 705   # Param 1 - Dirs to find in
 706   # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
 707   define CacheFind
 708     $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \
 709       $(if $(wildcard $1), $(shell $(FIND) $1 \( -type f -o -type l \) $2 \
 710           | $(TR) ' ' '?')), \
 711       $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE)))
 712   endef
 713 
 714 else
 715   # If CacheFind is disabled, just run the find command.
 716   # Param 1 - Dirs to find in
 717   # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
 718   define CacheFind
 719     $(shell $(FIND) $1 \( -type f -o -type l \) $2 | $(TR) ' ' '?')
 720   endef
 721 endif
 722 
 723 ################################################################################
 724 
 725 define AddFileToCopy
 726   # Helper macro for SetupCopyFiles
 727   # 1 : Source file
 728   # 2 : Dest file
 729   # 3 : Variable to add targets to
 730   # 4 : Macro to call for copy operation
 731   # 5 : Action text to log
 732   $2: $1
 733         $$(call LogInfo, $(strip $5) $$(patsubst $(OUTPUTDIR)/%,%,$$(call DecodeSpace, $$@)))
 734         $$($$(strip $4))
 735 
 736   $3 += $2
 737 endef
 738 
 739 # Returns the value of the first argument
 740 identity = \
 741     $(strip $1)
 742 
 743 # Setup make rules for copying files, with an option to do more complex
 744 # processing instead of copying.
 745 #
 746 # Parameter 1 is the name of the rule. This name is used as variable prefix,
 747 # and the targets generated are listed in a variable by that name.
 748 #
 749 # Remaining parameters are named arguments. These include:
 750 #   SRC     : Source root dir (defaults to dir of first file)
 751 #   DEST    : Dest root dir
 752 #   FILES   : List of files to copy with absolute paths, or path relative to SRC.
 753 #             Must be in SRC.
 754 #   FLATTEN : Set to flatten the directory structure in the DEST dir.
 755 #   MACRO   : Optionally override the default macro used for making the copy.
 756 #             Default is 'install-file'
 757 #   NAME_MACRO : Optionally supply a macro that rewrites the target file name
 758 #                based on the source file name
 759 #   LOG_ACTION : Optionally specify a different action text for log messages
 760 SetupCopyFiles = $(NamedParamsMacroTemplate)
 761 define SetupCopyFilesBody
 762 
 763   ifeq ($$($1_MACRO), )
 764     $1_MACRO := install-file
 765   endif
 766 
 767   # Default SRC to the dir of the first file.
 768   ifeq ($$($1_SRC), )
 769     $1_SRC := $$(dir $$(firstword $$($1_FILES)))
 770   endif
 771 
 772   ifeq ($$($1_NAME_MACRO), )
 773     $1_NAME_MACRO := identity
 774   endif
 775 
 776   ifeq ($$($1_LOG_ACTION), )
 777     $1_LOG_ACTION := Copying
 778   endif
 779 
 780   # Remove any trailing slash from SRC and DEST
 781   $1_SRC := $$(patsubst %/,%,$$($1_SRC))
 782   $1_DEST := $$(patsubst %/,%,$$($1_DEST))
 783 
 784   $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \
 785       $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \
 786       $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \
 787       $1, $$($1_MACRO), $$($1_LOG_ACTION))))
 788 
 789 endef
 790 
 791 ################################################################################
 792 # Parse a multiple-keyword variable, like FOO="KEYWORD1=val1;KEYWORD2=val2;..."
 793 # These will be converted into a series of variables like FOO_KEYWORD1=val1,
 794 # FOO_KEYWORD2=val2, etc. Unknown keywords will cause an error.
 795 #
 796 # Parameter 1 is the name of the rule, and is also the name of the variable.
 797 #
 798 # Remaining parameters are named arguments. These include:
 799 #   KEYWORDS          A list of valid keywords
 800 #   STRING_KEYWORDS   A list of valid keywords, processed as string. This means
 801 #       that '%20' will be replaced by ' ' to allow for multi-word strings.
 802 #
 803 ParseKeywordVariable = $(NamedParamsMacroTemplate)
 804 define ParseKeywordVariableBody
 805   ifneq ($$($1), )
 806     # To preserve spaces, substitute them with a hopefully unique pattern
 807     # before splitting and then re-substitute spaces back.
 808     $1_MANGLED := $$(subst $$(SPACE),||||,$$($1))
 809     $$(foreach mangled_part, $$(subst ;, , $$($1_MANGLED)), \
 810       $$(eval mangled_part_eval := $$(call DoubleDollar, $$(mangled_part))) \
 811       $$(eval part := $$$$(subst ||||,$$$$(SPACE),$$$$(mangled_part_eval))) \
 812       $$(eval $1_NO_MATCH := true) \
 813       $$(foreach keyword, $$($1_KEYWORDS), \
 814         $$(eval keyword_eval := $$(call DoubleDollar, $$(keyword))) \
 815         $$(if $$(filter $$(keyword)=%, $$(part)), \
 816           $$(eval $(strip $1)_$$$$(keyword_eval) := $$$$(strip $$$$(patsubst $$$$(keyword_eval)=%, %, $$$$(part)))) \
 817           $$(eval $1_NO_MATCH := ) \
 818         ) \
 819       ) \
 820       $$(foreach keyword, $$($1_STRING_KEYWORDS), \
 821         $$(eval keyword_eval := $$(call DoubleDollar, $$(keyword))) \
 822         $$(if $$(filter $$(keyword)=%, $$(part)), \
 823           $$(eval $(strip $1)_$$$$(keyword_eval) := $$$$(strip $$$$(subst %20, , $$$$(patsubst $$$$(keyword_eval)=%, %, $$$$(part))))) \
 824           $$(eval $1_NO_MATCH := ) \
 825         ) \
 826       ) \
 827       $$(if $$($1_NO_MATCH), \
 828         $$(if $$(filter $$(part), $$($1_KEYWORDS) $$($1_STRING_KEYWORDS)), \
 829           $$(info Keyword $$(part) for $1 needs to be assigned a value.) \
 830         , \
 831           $$(info $$(part) is not a valid keyword for $1.) \
 832           $$(info Valid keywords: $$($1_KEYWORDS) $$($1_STRING_KEYWORDS).) \
 833         ) \
 834         $$(error Cannot continue) \
 835       ) \
 836     )
 837   endif
 838 endef
 839 
 840 ################################################################################
 841 # ShellQuote
 842 #
 843 # Quotes a string with single quotes and replaces single quotes with '\'' so
 844 # that the contents survives being given to the shell.
 845 
 846 ShellQuote = \
 847     $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE)
 848 
 849 ################################################################################
 850 # FixPath
 851 #
 852 # On Windows, converts a path from cygwin/unix style (e.g. /bin/foo) into
 853 # "mixed mode" (e.g. c:/cygwin/bin/foo). On other platforms, return the path
 854 # unchanged.
 855 # This is normally not needed since we use the FIXPATH prefix for command lines,
 856 # but might be needed in certain circumstances.
 857 ifeq ($(OPENJDK_TARGET_OS), windows)
 858   FixPath = \
 859       $(shell $(CYGPATH) -m $1)
 860 else
 861   FixPath = \
 862       $1
 863 endif
 864 
 865 ################################################################################
 866 # Write to and read from file
 867 
 868 # Param 1 - File to read
 869 ReadFile = \
 870     $(shell $(CAT) $1)
 871 
 872 # Param 1 - Text to write
 873 # Param 2 - File to write to
 874 ifeq ($(HAS_FILE_FUNCTION), true)
 875   WriteFile = \
 876       $(file >$2,$(strip $1))
 877 else
 878   # Use printf to get consistent behavior on all platforms.
 879   WriteFile = \
 880       $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2)
 881 endif
 882 
 883 ################################################################################
 884 # DependOnVariable
 885 #
 886 # This macro takes a variable name and puts the value in a file only if the
 887 # value has changed since last. The name of the file is returned. This can be
 888 # used to create rule dependencies on make variable values. The following
 889 # example would get rebuilt if the value of SOME_VAR was changed:
 890 #
 891 # path/to/some-file: $(call DependOnVariable, SOME_VAR)
 892 #         echo $(SOME_VAR) > $@
 893 #
 894 # Note that leading and trailing white space in the value is ignored.
 895 #
 896 
 897 # Defines the sub directory structure to store variable value file in
 898 DependOnVariableDirName = \
 899     $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \
 900         $(subst $(TOPDIR)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \
 901           $(firstword $(MAKEFILE_LIST)), \
 902           $(CURDIR)/$(firstword $(MAKEFILE_LIST))))))
 903 
 904 # Defines the name of the file to store variable value in. Generates a name
 905 # unless parameter 2 is given.
 906 # Param 1 - Name of variable
 907 # Param 2 - (optional) name of file to store value in
 908 DependOnVariableFileName = \
 909     $(strip $(if $(strip $2), $2, \
 910       $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps))
 911 
 912 # Does the actual work with parameters stripped.
 913 # If the file exists AND the contents is the same as the variable, do nothing
 914 # else print a new file.
 915 # Always returns the name of the file where the value was printed.
 916 # Param 1 - Name of variable
 917 # Param 2 - (optional) name of file to store value in
 918 DependOnVariableHelper = \
 919     $(strip \
 920         $(eval -include $(call DependOnVariableFileName, $1, $2)) \
 921         $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\
 922           $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \
 923           $(if $(findstring $(LOG_LEVEL), trace), \
 924               $(info NewVariable $1: >$(strip $($1))<) \
 925               $(info OldVariable $1: >$(strip $($1_old))<)) \
 926           $(call WriteFile, $1_old:=$(call DoubleDollar,$(call EscapeHash,$($1))), \
 927               $(call DependOnVariableFileName, $1, $2))) \
 928         $(call DependOnVariableFileName, $1, $2) \
 929     )
 930 
 931 # Main macro
 932 # Param 1 - Name of variable
 933 # Param 2 - (optional) name of file to store value in
 934 DependOnVariable = \
 935     $(call DependOnVariableHelper,$(strip $1),$(strip $2))
 936 
 937 # LogCmdlines is only intended to be used by ExecuteWithLog
 938 ifeq ($(LOG_CMDLINES), true)
 939   LogCmdlines = $(info $(strip $1))
 940 else
 941   LogCmdlines =
 942 endif
 943 
 944 ################################################################################
 945 # ExecuteWithLog will run a command and log the output appropriately. This is
 946 # meant to be used by commands that do "real" work, like a compilation.
 947 # The output is stored in a specified log file, which is displayed at the end
 948 # of the build in case of failure. The  command line itself is stored in a file,
 949 # and also logged to stdout if the LOG=cmdlines option has been given.
 950 #
 951 # NOTE: If the command redirects stdout, the caller needs to wrap it in a
 952 # subshell (by adding parentheses around it), otherwise the redirect to the
 953 # subshell tee process will create a race condition where the target file may
 954 # not be fully written when the make recipe is done.
 955 #
 956 # Param 1 - The path to base the name of the log file / command line file on
 957 # Param 2 - The command to run
 958 ExecuteWithLog = \
 959   $(call LogCmdlines, Exececuting: [$(strip $2)]) \
 960   $(call WriteFile, $2, $(strip $1).cmdline) \
 961   ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \
 962       ( exitcode=$(DOLLAR)? && \
 963       $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(OUTPUTDIR)/%,%,$(strip $1))).log && \
 964       $(CP) $(strip $1).cmdline $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(OUTPUTDIR)/%,%,$(strip $1))).cmdline && \
 965       exit $(DOLLAR)exitcode ) )
 966 
 967 ################################################################################
 968 # Find lib dir for module
 969 # Param 1 - module name
 970 FindLibDirForModule = \
 971     $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)
 972 
 973 ################################################################################
 974 # Return a string suitable for use after a -classpath or --module-path option. It
 975 # will be correct and safe to use on all platforms. Arguments are given as space
 976 # separate classpath entries. Safe for multiple nested calls.
 977 # param 1 : A space separated list of classpath entries
 978 # The surrounding strip is needed to keep additional whitespace out
 979 PathList = \
 980   "$(subst $(SPACE),$(PATH_SEP),$(strip $(subst $(DQUOTE),,$1)))"
 981 
 982 ################################################################################
 983 # Check if a specified hotspot variant is being built, or at least one of a
 984 # list of variants. Will return 'true' or 'false'.
 985 # $1 - the variant to test for
 986 check-jvm-variant = \
 987   $(strip \
 988     $(if $(filter-out $(VALID_JVM_VARIANTS), $1), \
 989       $(error Internal error: Invalid variant tested: $1)) \
 990     $(if $(filter $1, $(JVM_VARIANTS)), true, false))
 991 
 992 ################################################################################
 993 # Converts a space separated list to a comma separated list.
 994 #
 995 # Replacing double-comma with a single comma is to workaround the issue with
 996 # some version of make on windows that doesn't substitute spaces with one comma
 997 # properly.
 998 CommaList = \
 999   $(strip \
1000       $(subst $(COMMA)$(COMMA),$(COMMA),$(subst $(SPACE),$(COMMA),$(strip $1))) \
1001   )
1002 
1003 ################################################################################
1004 # Converts a space separated list to a colon separated list.
1005 #
1006 # Replacing double-colon with a single colon is to workaround the issue with
1007 # some version of make on windows that doesn't substitute spaces with one colon
1008 # properly.
1009 ColonList = \
1010   $(strip \
1011       $(subst ::,:,$(subst $(SPACE),:,$(strip $1))) \
1012   )
1013 
1014 ################################################################################
1015 
1016 # Hook to include the corresponding custom file, if present.
1017 $(eval $(call IncludeCustomExtension, common/MakeBase.gmk))
1018 
1019 endif # _MAKEBASE_GMK