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