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