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 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=$(OUTPUT_ROOT)/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 translates $ into $$ to protect the string from make itself.
126 DoubleDollar = $(subst $$,$$$$,$(strip $1))
127
128 ################################################################################
129 # ListPathsSafely can be used to print command parameters to a file. This is
130 # typically done if the command line lenght risk being too long for the
131 # OS/shell. In later make versions, the file function can be used for this
132 # purpose. For earlier versions, a more complex implementation is provided.
133 #
134 # The function ListPathsSafely can be called either directly or, more commonly
135 # from a recipe line. If called from a recipe, it will be executed in the
136 # evaluation phase of that recipe, which means that it will write to the file
137 # before any other line in the recipe has been run.
138 ifeq ($(HAS_FILE_FUNCTION), true)
139 # Param 1 - Name of variable containing paths/arguments to output
140 # Param 2 - File to print to
141 # Param 3 - Set to true to append to file instead of overwriting
142 define ListPathsSafely
143 $$(call MakeDir, $$(dir $$(strip $2)))
144 $$(file $$(if $$(filter true, $$(strip $3)),>>,>) \
145 $$(strip $2),$$(subst $$(SPACE),$$(NEWLINE),$$(strip $$($$(strip $1)))))
146 endef
147
148 else # HAS_FILE_FUNCTION
149
150 $(eval compress_paths = \
151 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-pre-compress.incl)))
152 compress_paths += \
153 $(subst $(SRC_ROOT),X97, \
154 $(subst $(OUTPUT_ROOT),X98, \
155 $(subst X,X00, \
156 $(subst $(SPACE),\n,$(strip $1)))))
157 $(eval compress_paths += \
158 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-post-compress.incl)))
159
160 decompress_paths=$(SED) -f $(SRC_ROOT)/make/common/support/ListPathsSafely-uncompress.sed \
161 -e 's|X99|\\n|g' \
162 -e 's|X98|$(OUTPUT_ROOT)|g' -e 's|X97|$(SRC_ROOT)|g' \
163 -e 's|X00|X|g'
164
165 ListPathsSafely_IfPrintf = \
166 $(if $(word $3,$($(strip $1))), \
167 $(shell $(PRINTF) -- "$(strip $(call EscapeDollar, \
168 $(call compress_paths, $(wordlist $3,$4,$($(strip $1))))))\n" \
169 | $(decompress_paths) >> $2))
170
171 # Param 1 - Name of variable containing paths/arguments to output
172 # Param 2 - File to print to
173 # Param 3 - Set to true to append to file instead of overwriting
174 define ListPathsSafely
175 ifneq (,$$(word 10001,$$($1)))
176 $$(error Cannot list safely more than 10000 paths. $1 has $$(words $$($1)) paths!)
177 endif
178 $$(call MakeDir, $$(dir $2))
179 ifneq ($$(strip $3), true)
180 $$(shell $(RM) $$(strip $2))
181 endif
182
183 $$(call ListPathsSafely_IfPrintf,$1,$2,1,250)
184 $$(call ListPathsSafely_IfPrintf,$1,$2,251,500)
185 $$(call ListPathsSafely_IfPrintf,$1,$2,501,750)
186 $$(call ListPathsSafely_IfPrintf,$1,$2,751,1000)
187
188 $$(call ListPathsSafely_IfPrintf,$1,$2,1001,1250)
189 $$(call ListPathsSafely_IfPrintf,$1,$2,1251,1500)
190 $$(call ListPathsSafely_IfPrintf,$1,$2,1501,1750)
191 $$(call ListPathsSafely_IfPrintf,$1,$2,1751,2000)
192
193 $$(call ListPathsSafely_IfPrintf,$1,$2,2001,2250)
194 $$(call ListPathsSafely_IfPrintf,$1,$2,2251,2500)
195 $$(call ListPathsSafely_IfPrintf,$1,$2,2501,2750)
196 $$(call ListPathsSafely_IfPrintf,$1,$2,2751,3000)
197
198 $$(call ListPathsSafely_IfPrintf,$1,$2,3001,3250)
199 $$(call ListPathsSafely_IfPrintf,$1,$2,3251,3500)
200 $$(call ListPathsSafely_IfPrintf,$1,$2,3501,3750)
201 $$(call ListPathsSafely_IfPrintf,$1,$2,3751,4000)
202
203 $$(call ListPathsSafely_IfPrintf,$1,$2,4001,4250)
204 $$(call ListPathsSafely_IfPrintf,$1,$2,4251,4500)
205 $$(call ListPathsSafely_IfPrintf,$1,$2,4501,4750)
206 $$(call ListPathsSafely_IfPrintf,$1,$2,4751,5000)
207
208 $$(call ListPathsSafely_IfPrintf,$1,$2,5001,5250)
209 $$(call ListPathsSafely_IfPrintf,$1,$2,5251,5500)
210 $$(call ListPathsSafely_IfPrintf,$1,$2,5501,5750)
211 $$(call ListPathsSafely_IfPrintf,$1,$2,5751,6000)
212
213 $$(call ListPathsSafely_IfPrintf,$1,$2,6001,6250)
214 $$(call ListPathsSafely_IfPrintf,$1,$2,6251,6500)
215 $$(call ListPathsSafely_IfPrintf,$1,$2,6501,6750)
216 $$(call ListPathsSafely_IfPrintf,$1,$2,6751,7000)
217
218 $$(call ListPathsSafely_IfPrintf,$1,$2,7001,7250)
219 $$(call ListPathsSafely_IfPrintf,$1,$2,7251,7500)
220 $$(call ListPathsSafely_IfPrintf,$1,$2,7501,7750)
221 $$(call ListPathsSafely_IfPrintf,$1,$2,7751,8000)
222
223 $$(call ListPathsSafely_IfPrintf,$1,$2,8001,8250)
224 $$(call ListPathsSafely_IfPrintf,$1,$2,8251,8500)
225 $$(call ListPathsSafely_IfPrintf,$1,$2,8501,8750)
226 $$(call ListPathsSafely_IfPrintf,$1,$2,8751,9000)
227
228 $$(call ListPathsSafely_IfPrintf,$1,$2,9001,9250)
229 $$(call ListPathsSafely_IfPrintf,$1,$2,9251,9500)
230 $$(call ListPathsSafely_IfPrintf,$1,$2,9501,9750)
231 $$(call ListPathsSafely_IfPrintf,$1,$2,9751,10000)
232 endef
233 endif # HAS_FILE_FUNCTION
234
235 ################################################################################
236 # The source tips can come from the Mercurial repository, or in the files
237 # $(HGTIP_FILENAME) which contains the tip but is also positioned in the same
238 # directory as the original $(HGDIR) directory.
239 # These should not be := assignments, only used from the root Makefile.
240 HG_VERSION = $(shell $(HG) version 2> /dev/null)
241 HG_DIRECTORY=.hg
242 HGTIP_FILENAME=.hgtip
243 HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO
244 REPO_LIST = $(patsubst ./%,%,$(patsubst %/,%,$(sort $(dir \
245 $(shell $(CD) $(SRC_ROOT) ; \
246 $(LS) -d $(HG_SEARCH:%/REPO=%/$(HG_DIRECTORY)) \
247 $(HG_SEARCH:%/REPO=%/$(HGTIP_FILENAME)) \
248 2> /dev/null)))))
249
250 # Emit the repo:tip pairs to $@
251 define GetSourceTips
252 $(CD) $(SRC_ROOT) ; \
253 for i in $(REPO_LIST) IGNORE ; do \
254 if [ "$${i}" = "IGNORE" ] ; then \
255 continue; \
256 elif [ -d $${i}/$(HG_DIRECTORY) -a "$(HG_VERSION)" != "" ] ; then \
257 $(PRINTF) " %s:%s" \
258 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \
259 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \
260 $(PRINTF) " %s:%s" \
261 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \
262 fi; \
263 done >> $@
264 $(PRINTF) "\n" >> $@
265 endef
266
267 # Create the HGTIP_FILENAME file. Called from closed/make/SourceBundles.gmk
268 define CreateHgTip
269 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \
270 $(ECHO) $1/$(HGTIP_FILENAME)
271 endef
272
273 ################################################################################
274
275 define SetupLogging
276 ifeq ($$(LOG_LEVEL), trace)
277 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
278 # For each target executed, will print
279 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer)
280 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much
281 # (and causing a crash on Cygwin).
282 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris.
283 # Only use time if it's GNU time which supports format and output file.
284 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL)
285 SHELL := $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL)
286 endif
287 # Never remove warning messages; this is just for completeness
288 LOG_WARN :=
289 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),)
290 LogInfo = $$(info $$(strip $$1))
291 LOG_INFO :=
292 else
293 LogInfo =
294 LOG_INFO := > /dev/null
295 endif
296 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),)
297 LogDebug = $$(info $$(strip $$1))
298 LOG_DEBUG :=
299 else
300 LogDebug =
301 LOG_DEBUG := > /dev/null
302 endif
303 ifneq ($$(findstring $$(LOG_LEVEL), trace),)
304 LogTrace = $$(info $$(strip $$1))
305 LOG_TRACE :=
306 else
307 LogTrace =
308 LOG_TRACE := > /dev/null
309 endif
310 endef
311
312 # Make sure logging is setup for everyone that includes MakeBase.gmk.
313 $(eval $(call SetupLogging))
314
315 ################################################################################
316 # Creates a sequence of increasing numbers (inclusive).
317 # Param 1 - starting number
318 # Param 2 - ending number
319 sequence = \
320 $(wordlist $1, $2, $(strip \
321 $(eval SEQUENCE_COUNT :=) \
322 $(call _sequence-do,$(strip $2))))
323
324 _sequence-do = \
325 $(if $(word $1, $(SEQUENCE_COUNT)),, \
326 $(eval SEQUENCE_COUNT += .) \
327 $(words $(SEQUENCE_COUNT)) \
328 $(call _sequence-do,$1))
329
330 ################################################################################
331
332 MAX_PARAMS := 35
333 PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS))
334
335 # Template for creating a macro taking named parameters. To use it, assign the
336 # template to a variable with the name you want for your macro, using '='
337 # assignment. Then define a macro body with the suffix "Body". The Body macro
338 # should take 1 parameter which should be a unique string for that invocation
339 # of the macro.
340 # Ex:
341 # SetupFoo = $(NamedParamsMacroTemplate)
342 # define SetupFooBody
343 # # do something
344 # # access parameters as $$($1_BAR)
345 # endef
346 # Call it like this
347 # $(eval $(call SetupFoo, BUILD_SOMETHING, \
348 # BAR := some parameter value, \
349 # ))
350 define NamedParamsMacroTemplate
351 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \
352 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk))
353 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix
354 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\
355 $(strip $1)_$(strip $($i)))$(NEWLINE))
356 # Debug print all named parameter names and values
357 $(if $(findstring $(LOG_LEVEL),debug trace), \
358 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \
359 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \
360 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...)))))))
361
362 $(if $(DEBUG_$(strip $1)),
363 $(info -------- <<< Begin expansion of $(strip $1)) \
364 $(info $(call $(0)Body,$(strip $1))) \
365 $(info -------- >>> End expansion of $(strip $1)) \
366 )
367
368 $(call $(0)Body,$(strip $1))
369 endef
370
371 ################################################################################
372 # Make directory without forking mkdir if not needed
373 # 1: List of directories to create
374 MakeDir = \
375 $(strip $(if $(wildcard $1), , $(shell $(MKDIR) -p $1)))
376
377 ################################################################################
378 # Assign a variable only if it is empty
379 # Param 1 - Variable to assign
380 # Param 2 - Value to assign
381 SetIfEmpty = \
382 $(if $($(strip $1)),,$(eval $(strip $1) := $2))
383
384 ################################################################################
385
386 ifeq ($(OPENJDK_TARGET_OS),solaris)
387 # On Solaris, if the target is a symlink and exists, cp won't overwrite.
388 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the
389 # name of the target file differs from the source file, rename after copy.
390 # If the source and target parent directories are the same, recursive copy doesn't work
391 # so we fall back on regular copy, which isn't preserving symlinks.
392 define install-file
393 $(MKDIR) -p '$(@D)'
394 $(RM) '$@'
395 if [ "$(@D)" != "$(<D)" ]; then \
396 $(CP) -f -r -P '$<' '$(@D)'; \
397 if [ "$(@F)" != "$(<F)" ]; then \
398 $(MV) '$(@D)/$(<F)' '$@'; \
399 fi; \
400 else \
401 if [ -L '$<' ]; then \
402 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \
403 exit 1; \
404 fi; \
405 $(CP) -f '$<' '$@'; \
406 fi
407 endef
408 else ifeq ($(OPENJDK_TARGET_OS),macosx)
409 # On mac, extended attributes sometimes creep into the source files, which may later
410 # cause the creation of ._* files which confuses testing. Clear these with xattr if
411 # set. Some files get their write permissions removed after being copied to the
412 # output dir. When these are copied again to images, xattr would fail. By only clearing
413 # attributes when they are present, failing on this is avoided.
414 define install-file
415 $(MKDIR) -p '$(@D)'
416 $(CP) -fRP '$<' '$@'
417 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi
418 endef
419 else
420 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin
421 # significantly.
422 define install-file
423 $(call MakeDir, $(@D))
424 $(CP) -fP '$<' '$@'
425 endef
426 endif
427
428 ################################################################################
429 # Filter out duplicate sub strings while preserving order. Keeps the first occurance.
430 uniq = \
431 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))
432
433 # Returns all whitespace-separated words in $2 where at least one of the
434 # whitespace-separated words in $1 is a substring.
435 containing = \
436 $(strip \
437 $(foreach v,$(strip $2),\
438 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v)))))
439
440 # Returns all whitespace-separated words in $2 where none of the
441 # whitespace-separated words in $1 is a substring.
442 not-containing = \
443 $(strip $(filter-out $(call containing,$1,$2),$2))
444
445 # Return a list of all string elements that are duplicated in $1.
446 dups = \
447 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \
448 $(words $(filter $v, $1))), $v)))
449
450 # String equals
451 equals = \
452 $(and $(findstring $(strip $1),$(strip $2)),\
453 $(findstring $(strip $2),$(strip $1)))
454
455 # Remove a whole list of prefixes
456 # $1 - List of prefixes
457 # $2 - List of elements to process
458 remove-prefixes = \
459 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\
460 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2))
461
462 # Convert the string given to upper case, without any $(shell)
463 # Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html
464 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 \
465 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z
466
467 uppercase_internal = \
468 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \
469 $(wordlist 2, $(words $1), $1), $2)), $2)
470
471 # Convert a string to upper case. Works only on a-z.
472 # $1 - The string to convert
473 uppercase = \
474 $(strip \
475 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \
476 $(uppercase_result) \
477 )
478
479 ################################################################################
480
481 ifneq ($(DISABLE_CACHE_FIND), true)
482 # In Cygwin, finds are very costly, both because of expensive forks and because
483 # of bad file system caching. Find is used extensively in $(shell) commands to
484 # find source files. This makes rerunning make with no or few changes rather
485 # expensive. To speed this up, these two macros are used to cache the results
486 # of simple find commands for reuse.
487 #
488 # Runs a find and stores both the directories where it was run and the results.
489 # This macro can be called multiple times to add to the cache. Only finds files
490 # with no filters.
491 #
492 # Needs to be called with $(eval )
493 #
494 # Even if the performance benifit is negligible on other platforms, keep the
495 # functionality active unless explicitly disabled to exercise it more.
496 #
497 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable
498 FIND_CACHE_DIRS :=
499 # Param 1 - Dirs to find in
500 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
501 define FillCacheFind
502 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty
503 # since filter out will then return empty.
504 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\
505 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1)
506 ifneq ($$(FIND_CACHE_NEW_DIRS), )
507 # Remove any trailing slash from dirs in the cache dir list
508 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS))
509 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2))
510 endif
511 endef
512
513 # Mimics find by looking in the cache if all of the directories have been cached.
514 # Otherwise reverts to shell find. This is safe to call on all platforms, even if
515 # cache is deactivated.
516 #
517 # $1 can be either a directory or a file. If it's a directory, make
518 # sure we have exactly one trailing slash before the wildcard.
519 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless.
520 #
521 # Param 1 - Dirs to find in
522 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
523 define CacheFind
524 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \
525 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \
526 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE)))
527 endef
528
529 else
530 # If CacheFind is disabled, just run the find command.
531 # Param 1 - Dirs to find in
532 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.
533 define CacheFind
534 $(shell $(FIND) $1 \( -type f -o -type l \) $2)
535 endef
536 endif
537
538 ################################################################################
539
540 define AddFileToCopy
541 # Helper macro for SetupCopyFiles
542 # 1 : Source file
543 # 2 : Dest file
544 # 3 : Variable to add targets to
545 # 4 : Macro to call for copy operation
546 $2: $1
547 $$(call LogInfo, Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@))
548 $$($$(strip $4))
549
550 $3 += $2
551 endef
552
553 # Returns the value of the first argument
554 identity = \
555 $(strip $1)
556
557 # Setup make rules for copying files, with an option to do more complex
558 # processing instead of copying.
559 #
560 # Parameter 1 is the name of the rule. This name is used as variable prefix,
561 # and the targets generated are listed in a variable by that name.
562 #
563 # Remaining parameters are named arguments. These include:
564 # SRC : Source root dir (defaults to dir of first file)
565 # DEST : Dest root dir
566 # FILES : List of files to copy with absolute paths, or path relative to SRC.
567 # Must be in SRC.
568 # FLATTEN : Set to flatten the directory structure in the DEST dir.
569 # MACRO : Optionally override the default macro used for making the copy.
570 # Default is 'install-file'
571 # NAME_MACRO : Optionally supply a macro that rewrites the target file name
572 # based on the source file name
573 SetupCopyFiles = $(NamedParamsMacroTemplate)
574 define SetupCopyFilesBody
575
576 ifeq ($$($1_MACRO), )
577 $1_MACRO := install-file
578 endif
579
580 # Default SRC to the dir of the first file.
581 ifeq ($$($1_SRC), )
582 $1_SRC := $$(dir $$(firstword $$($1_FILES)))
583 endif
584
585 ifeq ($$($1_NAME_MACRO), )
586 $1_NAME_MACRO := identity
587 endif
588
589 # Remove any trailing slash from SRC and DEST
590 $1_SRC := $$(patsubst %/,%,$$($1_SRC))
591 $1_DEST := $$(patsubst %/,%,$$($1_DEST))
592
593 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \
594 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \
595 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \
596 $1, $$($1_MACRO))))
597
598 endef
599
600 ################################################################################
601 # ShellQuote
602 #
603 # Quotes a string with single quotes and replaces single quotes with '\'' so
604 # that the contents survives being given to the shell.
605
606 ShellQuote = \
607 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE)
608
609 ################################################################################
610 # Write to and read from file
611
612 # Param 1 - File to read
613 ReadFile = \
614 $(shell $(CAT) $1)
615
616 # Param 1 - Text to write
617 # Param 2 - File to write to
618 ifeq ($(HAS_FILE_FUNCTION), true)
619 WriteFile = \
620 $(file >$2,$(strip $1))
621 else
622 # Use printf to get consistent behavior on all platforms.
623 WriteFile = \
624 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2)
625 endif
626
627 ################################################################################
628 # DependOnVariable
629 #
630 # This macro takes a variable name and puts the value in a file only if the
631 # value has changed since last. The name of the file is returned. This can be
632 # used to create rule dependencies on make variable values. The following
633 # example would get rebuilt if the value of SOME_VAR was changed:
634 #
635 # path/to/some-file: $(call DependOnVariable, SOME_VAR)
636 # echo $(SOME_VAR) > $@
637 #
638 # Note that leading and trailing white space in the value is ignored.
639 #
640
641 # Defines the sub directory structure to store variable value file in
642 DependOnVariableDirName = \
643 $(strip $(subst $(SRC_ROOT)/,,\
644 $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \
645 $(firstword $(MAKEFILE_LIST)), \
646 $(CURDIR)/$(firstword $(MAKEFILE_LIST)))))
647
648 # Defines the name of the file to store variable value in. Generates a name
649 # unless parameter 2 is given.
650 # Param 1 - Name of variable
651 # Param 2 - (optional) name of file to store value in
652 DependOnVariableFileName = \
653 $(strip $(if $(strip $2), $2, \
654 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps))
655
656 # Does the actual work with parameters stripped.
657 # If the file exists AND the contents is the same as the variable, do nothing
658 # else print a new file.
659 # Always returns the name of the file where the value was printed.
660 # Param 1 - Name of variable
661 # Param 2 - (optional) name of file to store value in
662 DependOnVariableHelper = \
663 $(strip \
664 $(eval -include $(call DependOnVariableFileName, $1, $2)) \
665 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\
666 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \
667 $(if $(findstring $(LOG_LEVEL), trace), \
668 $(info NewVariable $1: >$(strip $($1))<) \
669 $(info OldVariable $1: >$(strip $($1_old))<)) \
670 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \
671 $(call DependOnVariableFileName, $1, $2))) \
672 $(call DependOnVariableFileName, $1, $2) \
673 )
674
675 # Main macro
676 # Param 1 - Name of variable
677 # Param 2 - (optional) name of file to store value in
678 DependOnVariable = \
679 $(call DependOnVariableHelper,$(strip $1),$(strip $2))
680
681 ################################################################################
682 # Failure logging support macros. These are supposed to be used by the Setup*
683 # compilation macros.
684 #
685 # LogFailures will run a command and store a copy of output in a specified file.
686 # If the command succeeds, the file is deleted, otherwise it is moved to the
687 # failure-logs directory.
688 # Param 1 - The log file of the failed command
689 # Param 2 - A compact but representative name to describe this command
690 # Param 3 - Command to run
691 LogFailures = \
692 ( $3 > >($(TEE) $1) 2> >($(TEE) $1 >&2) || \
693 (exitcode=$(DOLLAR)$(DOLLAR)? && \
694 $(CP) $1 $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(strip $2).log && \
695 exit $(DOLLAR)$(DOLLAR)exitcode) )
696
697 ################################################################################
698 # Find lib dir for module
699 # Param 1 - module name
700 ifeq ($(OPENJDK_TARGET_OS_TYPE), unix)
701 FindLibDirForModule = \
702 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)$(OPENJDK_TARGET_CPU_LIBDIR)
703 else
704 FindLibDirForModule = \
705 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)
706 endif
707
708 ################################################################################
709 # Return a string suitable for use after a -classpath option. It will correct and safe to use
710 # on all platforms. Arguments are given as space separate classpath entries.
711 # param 1 : A space separated list of classpath entries
712 # The surrounding strip is needed to keep additional whitespace out
713 PathList = \
714 "$(subst $(SPACE),$(PATH_SEP),$(strip $1))"
715
716 ################################################################################
717
718 # Hook to include the corresponding custom file, if present.
719 $(eval $(call IncludeCustomExtension, , common/MakeBase.gmk))
720
721 endif # _MAKEBASE_GMK