Thu, 27 Dec 2012 20:55:53 +0100
8005548: build-infra: Fix docs target on windows
Summary: Fix path sep variable
Reviewed-by: tbell
1 #
2 # Copyright (c) 2011, 2012, 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 #
26 ################################################################
27 #
28 # Check that GNU make and cygwin are recent enough.
29 # Setup common utility functions.
30 #
31 ################################################################
33 ifndef _MAKEBASE_GMK
34 _MAKEBASE_GMK := 1
36 # If the variable that you want to send to stdout for piping into a file or otherwise,
37 # is potentially long, for example the a list of file paths, eg a list of all package directories.
38 # Then you need to use ListPathsSafely, which optimistically splits the output into several shell
39 # calls as well as use compression on recurrent file paths segments, to get around the potential
40 # command line length problem that exists in cygwin and other shells.
41 compress_pre:=$(strip $(shell $(CAT) $(SRC_ROOT)/common/makefiles/support/ListPathsSafely-pre-compress.incl))
42 compress_post:=$(strip $(shell $(CAT) $(SRC_ROOT)/common/makefiles/support/ListPathsSafely-post-compress.incl))
43 compress_paths=$(compress_pre)\
44 $(subst $(SRC_ROOT),X97,\
45 $(subst $(OUTPUT_ROOT),X98,\
46 $(subst X,X00,\
47 $(subst $(SPACE),\n,$(strip $1)))))\
48 $(compress_post)
50 decompress_paths=$(SED) -f $(SRC_ROOT)/common/makefiles/support/ListPathsSafely-uncompress.sed -e 's|X99|\\n|g' \
51 -e 's|X98|$(OUTPUT_ROOT)|g' -e 's|X97|$(SRC_ROOT)|g' \
52 -e 's|X00|X|g' | tr '\n' '$2'
54 define ListPathsSafely_If
55 $(if $(word $3,$($1)),$(eval $1_LPS$3:=$(call compress_paths,$(wordlist $3,$4,$($1)))))
56 endef
58 define ListPathsSafely_Printf
59 $(if $(strip $($1_LPS$4)),printf -- "$(strip $($1_LPS$4))\n" | $(decompress_paths) $3)
60 endef
62 # Receipt example:
63 # rm -f thepaths
64 # $(call ListPathsSafely,THEPATHS,\n, >> thepaths)
65 # The \n argument means translate spaces into \n
66 # if instead , , (a space) is supplied, then spaces remain spaces.
67 define ListPathsSafely
68 $(if $(word 16001,$($1)),$(error Cannot list safely more than 16000 paths. $1 has $(words $($1)) paths!))
69 $(call ListPathsSafely_If,$1,$2,1,250)
70 $(call ListPathsSafely_If,$1,$2,251,500)
71 $(call ListPathsSafely_If,$1,$2,501,750)
72 $(call ListPathsSafely_If,$1,$2,751,1000)
74 $(call ListPathsSafely_If,$1,$2,1001,1250)
75 $(call ListPathsSafely_If,$1,$2,1251,1500)
76 $(call ListPathsSafely_If,$1,$2,1501,1750)
77 $(call ListPathsSafely_If,$1,$2,1751,2000)
79 $(call ListPathsSafely_If,$1,$2,2001,2250)
80 $(call ListPathsSafely_If,$1,$2,2251,2500)
81 $(call ListPathsSafely_If,$1,$2,2501,2750)
82 $(call ListPathsSafely_If,$1,$2,2751,3000)
84 $(call ListPathsSafely_If,$1,$2,3001,3250)
85 $(call ListPathsSafely_If,$1,$2,3251,3500)
86 $(call ListPathsSafely_If,$1,$2,3501,3750)
87 $(call ListPathsSafely_If,$1,$2,3751,4000)
89 $(call ListPathsSafely_If,$1,$2,4001,4250)
90 $(call ListPathsSafely_If,$1,$2,4251,4500)
91 $(call ListPathsSafely_If,$1,$2,4501,4750)
92 $(call ListPathsSafely_If,$1,$2,4751,5000)
94 $(call ListPathsSafely_If,$1,$2,5001,5250)
95 $(call ListPathsSafely_If,$1,$2,5251,5500)
96 $(call ListPathsSafely_If,$1,$2,5501,5750)
97 $(call ListPathsSafely_If,$1,$2,5751,6000)
99 $(call ListPathsSafely_If,$1,$2,6001,6250)
100 $(call ListPathsSafely_If,$1,$2,6251,6500)
101 $(call ListPathsSafely_If,$1,$2,6501,6750)
102 $(call ListPathsSafely_If,$1,$2,6751,7000)
104 $(call ListPathsSafely_If,$1,$2,7001,7250)
105 $(call ListPathsSafely_If,$1,$2,7251,7500)
106 $(call ListPathsSafely_If,$1,$2,7501,7750)
107 $(call ListPathsSafely_If,$1,$2,7751,8000)
109 $(call ListPathsSafely_If,$1,$2,8001,8250)
110 $(call ListPathsSafely_If,$1,$2,8251,8500)
111 $(call ListPathsSafely_If,$1,$2,8501,8750)
112 $(call ListPathsSafely_If,$1,$2,8751,9000)
114 $(call ListPathsSafely_If,$1,$2,9001,9250)
115 $(call ListPathsSafely_If,$1,$2,9251,9500)
116 $(call ListPathsSafely_If,$1,$2,9501,9750)
117 $(call ListPathsSafely_If,$1,$2,9751,10000)
119 $(call ListPathsSafely_If,$1,$2,10001,10250)
120 $(call ListPathsSafely_If,$1,$2,10251,10500)
121 $(call ListPathsSafely_If,$1,$2,10501,10750)
122 $(call ListPathsSafely_If,$1,$2,10751,11000)
124 $(call ListPathsSafely_If,$1,$2,11001,11250)
125 $(call ListPathsSafely_If,$1,$2,11251,11500)
126 $(call ListPathsSafely_If,$1,$2,11501,11750)
127 $(call ListPathsSafely_If,$1,$2,11751,12000)
129 $(call ListPathsSafely_If,$1,$2,12001,12250)
130 $(call ListPathsSafely_If,$1,$2,12251,12500)
131 $(call ListPathsSafely_If,$1,$2,12501,12750)
132 $(call ListPathsSafely_If,$1,$2,12751,13000)
134 $(call ListPathsSafely_If,$1,$2,13001,13250)
135 $(call ListPathsSafely_If,$1,$2,13251,13500)
136 $(call ListPathsSafely_If,$1,$2,13501,13750)
137 $(call ListPathsSafely_If,$1,$2,13751,14000)
139 $(call ListPathsSafely_If,$1,$2,14001,14250)
140 $(call ListPathsSafely_If,$1,$2,14251,14500)
141 $(call ListPathsSafely_If,$1,$2,14501,14750)
142 $(call ListPathsSafely_If,$1,$2,14751,15000)
144 $(call ListPathsSafely_If,$1,$2,15001,15250)
145 $(call ListPathsSafely_If,$1,$2,15251,15500)
146 $(call ListPathsSafely_If,$1,$2,15501,15750)
147 $(call ListPathsSafely_If,$1,$2,15751,16000)
149 $(call ListPathsSafely_Printf,$1,$2,$3,1)
150 $(call ListPathsSafely_Printf,$1,$2,$3,251)
151 $(call ListPathsSafely_Printf,$1,$2,$3,501)
152 $(call ListPathsSafely_Printf,$1,$2,$3,751)
154 $(call ListPathsSafely_Printf,$1,$2,$3,1001)
155 $(call ListPathsSafely_Printf,$1,$2,$3,1251)
156 $(call ListPathsSafely_Printf,$1,$2,$3,1501)
157 $(call ListPathsSafely_Printf,$1,$2,$3,1751)
159 $(call ListPathsSafely_Printf,$1,$2,$3,2001)
160 $(call ListPathsSafely_Printf,$1,$2,$3,2251)
161 $(call ListPathsSafely_Printf,$1,$2,$3,2501)
162 $(call ListPathsSafely_Printf,$1,$2,$3,2751)
164 $(call ListPathsSafely_Printf,$1,$2,$3,3001)
165 $(call ListPathsSafely_Printf,$1,$2,$3,3251)
166 $(call ListPathsSafely_Printf,$1,$2,$3,3501)
167 $(call ListPathsSafely_Printf,$1,$2,$3,3751)
169 $(call ListPathsSafely_Printf,$1,$2,$3,4001)
170 $(call ListPathsSafely_Printf,$1,$2,$3,4251)
171 $(call ListPathsSafely_Printf,$1,$2,$3,4501)
172 $(call ListPathsSafely_Printf,$1,$2,$3,4751)
174 $(call ListPathsSafely_Printf,$1,$2,$3,5001)
175 $(call ListPathsSafely_Printf,$1,$2,$3,5251)
176 $(call ListPathsSafely_Printf,$1,$2,$3,5501)
177 $(call ListPathsSafely_Printf,$1,$2,$3,5751)
179 $(call ListPathsSafely_Printf,$1,$2,$3,6001)
180 $(call ListPathsSafely_Printf,$1,$2,$3,6251)
181 $(call ListPathsSafely_Printf,$1,$2,$3,6501)
182 $(call ListPathsSafely_Printf,$1,$2,$3,6751)
184 $(call ListPathsSafely_Printf,$1,$2,$3,7001)
185 $(call ListPathsSafely_Printf,$1,$2,$3,7251)
186 $(call ListPathsSafely_Printf,$1,$2,$3,7501)
187 $(call ListPathsSafely_Printf,$1,$2,$3,7751)
189 $(call ListPathsSafely_Printf,$1,$2,$3,8001)
190 $(call ListPathsSafely_Printf,$1,$2,$3,8251)
191 $(call ListPathsSafely_Printf,$1,$2,$3,8501)
192 $(call ListPathsSafely_Printf,$1,$2,$3,8751)
194 $(call ListPathsSafely_Printf,$1,$2,$3,9001)
195 $(call ListPathsSafely_Printf,$1,$2,$3,9251)
196 $(call ListPathsSafely_Printf,$1,$2,$3,9501)
197 $(call ListPathsSafely_Printf,$1,$2,$3,9751)
199 $(call ListPathsSafely_Printf,$1,$2,$3,10001)
200 $(call ListPathsSafely_Printf,$1,$2,$3,10251)
201 $(call ListPathsSafely_Printf,$1,$2,$3,10501)
202 $(call ListPathsSafely_Printf,$1,$2,$3,10751)
204 $(call ListPathsSafely_Printf,$1,$2,$3,11001)
205 $(call ListPathsSafely_Printf,$1,$2,$3,11251)
206 $(call ListPathsSafely_Printf,$1,$2,$3,11501)
207 $(call ListPathsSafely_Printf,$1,$2,$3,11751)
209 $(call ListPathsSafely_Printf,$1,$2,$3,12001)
210 $(call ListPathsSafely_Printf,$1,$2,$3,12251)
211 $(call ListPathsSafely_Printf,$1,$2,$3,12501)
212 $(call ListPathsSafely_Printf,$1,$2,$3,12751)
214 $(call ListPathsSafely_Printf,$1,$2,$3,13001)
215 $(call ListPathsSafely_Printf,$1,$2,$3,13251)
216 $(call ListPathsSafely_Printf,$1,$2,$3,13501)
217 $(call ListPathsSafely_Printf,$1,$2,$3,13751)
219 $(call ListPathsSafely_Printf,$1,$2,$3,14001)
220 $(call ListPathsSafely_Printf,$1,$2,$3,14251)
221 $(call ListPathsSafely_Printf,$1,$2,$3,14501)
222 $(call ListPathsSafely_Printf,$1,$2,$3,14751)
224 $(call ListPathsSafely_Printf,$1,$2,$3,15001)
225 $(call ListPathsSafely_Printf,$1,$2,$3,15251)
226 $(call ListPathsSafely_Printf,$1,$2,$3,15501)
227 $(call ListPathsSafely_Printf,$1,$2,$3,15751)
228 endef
230 define ListPathsSafelyNow_IfPrintf
231 ifneq (,$$(word $4,$$($1)))
232 $$(eval $1_LPS$4:=$$(call compress_paths,$$(wordlist $4,$5,$$($1))))
233 $$(shell printf -- "$$(strip $$($1_LPS$4))\n" | $(decompress_paths) $3)
234 endif
235 endef
237 # And an non-receipt version:
238 define ListPathsSafelyNow
239 ifneq (,$$(word 10001,$$($1)))
240 $$(error Cannot list safely more than 10000 paths. $1 has $$(words $$($1)) paths!)
241 endif
242 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1,250)
243 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,251,500)
244 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,501,750)
245 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,751,1000)
247 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1001,1250)
248 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1251,1500)
249 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1501,1750)
250 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,1751,2000)
252 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2001,2250)
253 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2251,2500)
254 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2501,2750)
255 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,2751,3000)
257 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3001,3250)
258 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3251,3500)
259 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3501,3750)
260 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,3751,4000)
262 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4001,4250)
263 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4251,4500)
264 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4501,4750)
265 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,4751,5000)
267 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5001,5250)
268 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5251,5500)
269 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5501,5750)
270 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,5751,6000)
272 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6001,6250)
273 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6251,6500)
274 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6501,6750)
275 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,6751,7000)
277 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7001,7250)
278 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7251,7500)
279 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7501,7750)
280 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,7751,8000)
282 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8001,8250)
283 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8251,8500)
284 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8501,8750)
285 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,8751,9000)
287 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9001,9250)
288 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9251,9500)
289 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9501,9750)
290 $(call ListPathsSafelyNow_IfPrintf,$1,$2,$3,9751,10000)
292 endef
294 # The source tips can come from the Mercurial repository, or in the files
295 # $(HGTIP_FILENAME) which contains the tip but is also positioned in the same
296 # directory as the original $(HGDIR) directory.
297 # These should not be := assignments, only used from the root Makefile.
298 HG_VERSION = $(shell $(HG) version 2> /dev/null)
299 HG_DIRECTORY=.hg
300 HGTIP_FILENAME=.hgtip
301 HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO
302 REPO_LIST = $(patsubst ./%,%,$(patsubst %/,%,$(sort $(dir \
303 $(shell $(CD) $(SRC_ROOT) ; ( $(LS) -d $(HG_SEARCH:%/REPO=%/$(HG_DIRECTORY)) ; \
304 $(LS) $(HG_SEARCH:%/REPO=%/$(HGTIP_FILENAME)) ) \
305 2> /dev/null)))))
307 # Emit the repo:tip pairs to $@
308 define GetSourceTips
309 $(CD) $(SRC_ROOT) ; \
310 for i in $(REPO_LIST) IGNORE ; do \
311 if [ "$${i}" = "IGNORE" ] ; then \
312 continue; \
313 elif [ -d $${i}/$(HG_DIRECTORY) -a "$(HG_VERSION)" != "" ] ; then \
314 $(PRINTF) " %s:%s" \
315 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \
316 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \
317 $(PRINTF) " %s:%s" \
318 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \
319 fi; \
320 done >> $@
321 $(PRINTF) "\n" >> $@
322 endef
324 # Create the HGTIP_FILENAME file. Called from jdk/make/closed/bundles.gmk
325 define CreateHgTip
326 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME);\
327 $(ECHO) $1/$(HGTIP_FILENAME)
328 endef
330 define SetupLogging
331 ifeq ($$(LOG), trace)
332 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
333 # For each target executed, will print
334 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer)
335 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much (and causing a crash on Cygwin).
336 OLD_SHELL:=$$(SHELL)
337 WRAPPER_SHELL:=$$(OLD_SHELL) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(TIME),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(OLD_SHELL)
338 SHELL=$$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL)
339 endif
340 # Never remove warning messages; this is just for completeness
341 LOG_WARN=
342 ifneq ($$(findstring $$(LOG),info debug trace),)
343 LOG_INFO=
344 else
345 LOG_INFO=> /dev/null
346 endif
347 ifneq ($$(findstring $$(LOG),debug trace),)
348 LOG_DEBUG=
349 else
350 LOG_DEBUG=> /dev/null
351 endif
352 ifneq ($$(findstring $$(LOG),trace),)
353 LOG_TRACE=
354 else
355 LOG_TRACE=> /dev/null
356 endif
357 endef
359 # Make sure logging is setup for everyone that includes MakeBase.gmk.
360 $(eval $(call SetupLogging))
362 # This is to be called by all SetupFoo macros
363 define LogSetupMacroEntry
364 $(if $(26),$(error Internal makefile error: Too many arguments to LogSetupMacroEntry, please update MakeBase.gmk))
365 $(if $(findstring $(LOG),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,$(if $($i),$(NEWLINE) $(strip [$i] $($i))))))
366 endef
368 # Make directory without forking mkdir if not needed
369 define MakeDir
370 ifneq ($$(wildcard $1 $2 $3 $4 $5 $6 $7 $8 $9),$$(strip $1 $2 $3 $4 $5 $6 $7 $8 $9))
371 $$(shell $(MKDIR) -p $1 $2 $3 $4 $5 $6 $7 $8 $9)
372 endif
373 endef
375 ifeq ($(OPENJDK_TARGET_OS),solaris)
376 # On Solaris, if the target is a symlink and exists, cp won't overwrite.
377 define install-file
378 $(MKDIR) -p $(@D)
379 $(RM) '$@'
380 $(CP) -f -r -P '$<' '$(@D)'
381 endef
382 else ifeq ($(OPENJDK_TARGET_OS),macosx)
383 define install-file
384 $(MKDIR) -p $(@D)
385 $(CP) -fpRP '$<' '$@'
386 endef
387 else
388 define install-file
389 $(MKDIR) -p $(@D)
390 $(CP) -fP '$<' '$@'
391 endef
392 endif
394 # Convenience functions for working around make's limitations with $(filter ).
395 containing = $(foreach v,$2,$(if $(findstring $1,$v),$v))
396 not-containing = $(foreach v,$2,$(if $(findstring $1,$v),,$v))
398 ################################################################################
399 # In Cygwin, finds are very costly, both because of expensive forks and because
400 # of bad file system caching. Find is used extensively in $(shell) commands to
401 # find source files. This makes rerunning make with no or few changes rather
402 # expensive. To speed this up, these two macros are used to cache the results
403 # of simple find commands for reuse.
404 #
405 # Runs a find and stores both the directories where it was run and the results.
406 # This macro can be called multiple times to add to the cache. Only finds files
407 # with no filters.
408 #
409 # Needs to be called with $(eval )
410 #
411 # Param 1 - Dir to find in
412 ifeq ($(OPENJDK_BUILD_OS),windows)
413 define FillCacheFind
414 FIND_CACHE_DIR += $1
415 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $1 -type f -o -type l))
416 endef
417 else
418 define FillCacheFind
419 endef
420 endif
422 # Mimics find by looking in the cache if all of the directories have been cached.
423 # Otherwise reverts to shell find. This is safe to call on all platforms, even if
424 # cache is deactivated.
425 #
426 # The extra - is needed when FIND_CACHE_DIR is empty but should be harmless.
427 # Param 1 - Dirs to find in
428 define CacheFind
429 $(if $(filter-out $(addsuffix %,- $(FIND_CACHE_DIR)),$1),\
430 $(shell $(FIND) $1 -type f -o -type l),\
431 $(filter $(addsuffix %,$1),$(FIND_CACHE)))
432 endef
434 ################################################################################
436 endif # _MAKEBASE_GMK