xref: /freebsd/contrib/bmake/mk/dirdeps.mk (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1# $Id: dirdeps.mk,v 1.140 2021/06/20 23:42:38 sjg Exp $
2
3# Copyright (c) 2010-2021, Simon J. Gerraty
4# Copyright (c) 2010-2018, Juniper Networks, Inc.
5# All rights reserved.
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28# Much of the complexity here is for supporting cross-building.
29# If a tree does not support that, simply using plain Makefile.depend
30# should provide sufficient clue.
31# Otherwise the recommendation is to use Makefile.depend.${MACHINE}
32# as expected below.
33
34# Note: this file gets multiply included.
35# This is what we do with DIRDEPS
36
37# DIRDEPS:
38#	This is a list of directories - relative to SRCTOP, it is
39#	normally only of interest to .MAKE.LEVEL 0.
40#	In some cases the entry may be qualified with a .<machine>
41#	or .<target_spec> suffix (see TARGET_SPEC_VARS below),
42#	for example to force building something for the pseudo
43#	machines "host" or "common" regardless of current ${MACHINE}.
44#
45#	All unqualified entries end up being qualified with .${TARGET_SPEC}
46#	and partially qualified (if TARGET_SPEC_VARS has multiple
47#	entries) are also expanded to a full .<target_spec>.
48#	The  _DIRDEP_USE target uses the suffix to set TARGET_SPEC
49#	correctly when visiting each entry.
50#
51#	The fully qualified directory entries are used to construct a
52#	dependency graph that will drive the build later.
53#
54#	Also, for each fully qualified directory target, we will search
55#	using ${.MAKE.DEPENDFILE_PREFERENCE} to find additional
56#	dependencies.  We use Makefile.depend (default value for
57#	.MAKE.DEPENDFILE_PREFIX) to refer to these makefiles to
58#	distinguish them from others.
59#
60#	Before each Makefile.depend file is read, we set
61#	DEP_RELDIR to be the RELDIR (path relative to SRCTOP) for
62#	its directory, and DEP_MACHINE etc according to the .<target_spec>
63#	represented by the suffix of the corresponding target.
64#
65#	Since each Makefile.depend file includes dirdeps.mk, this
66#	processing is recursive and results in .MAKE.LEVEL 0 learning the
67#	dependencies of the tree wrt the initial directory (_DEP_RELDIR).
68#
69# TARGET_SPEC_VARS
70#	The default value is just MACHINE, and for most environments
71#	this is sufficient.  The _DIRDEP_USE target actually sets
72#	both MACHINE and TARGET_SPEC to the suffix of the current
73#	target so that in the general case TARGET_SPEC can be ignored.
74#
75#	If more than MACHINE is needed then sys.mk needs to decompose
76#	TARGET_SPEC and set the relevant variables accordingly.
77#	It is important that MACHINE be included in and actually be
78#	the first member of TARGET_SPEC_VARS.  This allows other
79#	variables to be considered optional, and some of the treatment
80#	below relies on MACHINE being the first entry.
81#	Note: TARGET_SPEC cannot contain any '.'s so the target
82#	triple used by compiler folk won't work (directly anyway).
83#
84#	For example:
85#
86#		# Always list MACHINE first,
87#		# other variables might be optional.
88#		TARGET_SPEC_VARS = MACHINE TARGET_OS
89#		.if ${TARGET_SPEC:Uno:M*,*} != ""
90#		_tspec := ${TARGET_SPEC:S/,/ /g}
91#		MACHINE := ${_tspec:[1]}
92#		TARGET_OS := ${_tspec:[2]}
93#		# etc.
94#		# We need to stop that TARGET_SPEC affecting any submakes
95#		# and deal with MACHINE=${TARGET_SPEC} in the environment.
96#		TARGET_SPEC =
97#		# export but do not track
98#		.export-env TARGET_SPEC
99#		.export ${TARGET_SPEC_VARS}
100#		.for v in ${TARGET_SPEC_VARS:O:u}
101#		.if empty($v)
102#		.undef $v
103#		.endif
104#		.endfor
105#		.endif
106#		# make sure we know what TARGET_SPEC is
107#		# as we may need it to find Makefile.depend*
108#		TARGET_SPEC = ${TARGET_SPEC_VARS:@v@${$v:U}@:ts,}
109#
110#	The following variables can influence the initial DIRDEPS
111#	computation with regard to the TARGET_SPECs that will be
112#	built.
113#	Most should also be considered by init.mk
114#
115#	ONLY_TARGET_SPEC_LIST
116#		Defines a list of TARGET_SPECs for which the current
117#		directory can be built.
118#		If ALL_MACHINES is defined, we build for all the
119#		TARGET_SPECs listed.
120#
121#	ONLY_MACHINE_LIST
122#		As for ONLY_TARGET_SPEC_LIST but only specifies
123#		MACHINEs.
124#
125#	NOT_TARGET_SPEC_LIST
126#		A list of TARGET_SPECs for which the current
127#		directory should not be built.
128#
129#	NOT_MACHINE_LIST
130#		A list of MACHINEs the current directory should not be
131#		built for.
132#
133# _build_xtra_dirs
134#	local.dirdeps.mk can add targets to this variable.
135#	They will be hooked into the build, but independent of
136#	any other DIRDEP.
137#
138#	This allows for adding TESTS to the build, such that the build
139#	if any test fails, but without the risk of introducing
140#	circular dependencies.
141
142now_utc ?= ${%s:L:gmtime}
143.if !defined(start_utc)
144start_utc := ${now_utc}
145.endif
146
147.if !target(bootstrap) && (make(bootstrap) || \
148	make(bootstrap-this) || \
149	make(bootstrap-recurse) || \
150	make(bootstrap-empty))
151# disable most of below
152.MAKE.LEVEL = 1
153.endif
154
155# touch this at your peril
156_DIRDEP_USE_LEVEL?= 0
157.if ${.MAKE.LEVEL} == ${_DIRDEP_USE_LEVEL}
158# only the first instance is interested in all this
159
160.if !target(_DIRDEP_USE)
161
162# do some setup we only need once
163_CURDIR ?= ${.CURDIR}
164_OBJDIR ?= ${.OBJDIR}
165
166.if ${MAKEFILE:T} == ${.PARSEFILE} && empty(DIRDEPS) && ${.TARGETS:Uall:M*/*} != ""
167# This little trick let's us do
168#
169# mk -f dirdeps.mk some/dir.${TARGET_SPEC}
170#
171all:
172${.TARGETS:Nall}: all
173DIRDEPS := ${.TARGETS:M*[/.]*}
174# so that -DNO_DIRDEPS works
175DEP_RELDIR := ${DIRDEPS:[1]:R}
176# this will become DEP_MACHINE below
177TARGET_MACHINE := ${DIRDEPS:[1]:E:C/,.*//}
178.if ${TARGET_MACHINE:N*/*} == ""
179TARGET_MACHINE := ${MACHINE}
180.endif
181# disable DIRDEPS_CACHE as it does not like this trick
182MK_DIRDEPS_CACHE = no
183.endif
184
185# make sure we get the behavior we expect
186.MAKE.SAVE_DOLLARS = no
187
188# make sure these are empty to start with
189_DEP_TARGET_SPEC =
190
191# If TARGET_SPEC_VARS is other than just MACHINE
192# it should be set by sys.mk or similar by now.
193# TARGET_SPEC must not contain any '.'s.
194TARGET_SPEC_VARS ?= MACHINE
195# this is what we started with
196TARGET_SPEC = ${TARGET_SPEC_VARS:@v@${$v:U}@:ts,}
197# this is what we mostly use below
198DEP_TARGET_SPEC = ${TARGET_SPEC_VARS:S,^,DEP_,:@v@${$v:U}@:ts,}
199# make sure we have defaults
200.for v in ${TARGET_SPEC_VARS}
201DEP_$v ?= ${$v}
202.endfor
203
204.if ${TARGET_SPEC_VARS:[#]} > 1
205# Ok, this gets more complex (putting it mildly).
206# In order to stay sane, we need to ensure that all the build_dirs
207# we compute below are fully qualified wrt DEP_TARGET_SPEC.
208# The makefiles may only partially specify (eg. MACHINE only),
209# so we need to construct a set of modifiers to fill in the gaps.
210.if ${MAKE_VERSION} >= 20170130
211_tspec_x := ${TARGET_SPEC_VARS:range}
212.else
213# do it the hard way
214_tspec_x := ${TARGET_SPEC_VARS:[#]:@x@i=1;while [ $$i -le $x ]; do echo $$i; i=$$((i + 1)); done;@:sh}
215.endif
216# this handles unqualified entries
217M_dep_qual_fixes = C;(/[^/.,]+)$$;\1.$${DEP_TARGET_SPEC};
218# there needs to be at least one item missing for these to make sense
219.for i in ${_tspec_x:[2..-1]}
220_tspec_m$i := ${TARGET_SPEC_VARS:[2..$i]:@w@[^,]+@:ts,}
221_tspec_a$i := ,${TARGET_SPEC_VARS:[$i..-1]:@v@$$$${DEP_$v}@:ts,}
222M_dep_qual_fixes += C;(\.${_tspec_m$i})$$;\1${_tspec_a$i};
223.endfor
224TARGET_SPEC_VARSr := ${TARGET_SPEC_VARS:[-1..1]}
225.else
226# A harmless? default.
227M_dep_qual_fixes = U
228.endif
229
230.if !defined(.MAKE.DEPENDFILE_PREFERENCE)
231# .MAKE.DEPENDFILE_PREFERENCE makes the logic below neater?
232# you really want this set by sys.mk or similar
233.MAKE.DEPENDFILE_PREFERENCE = ${_CURDIR}/${.MAKE.DEPENDFILE:T}
234.if ${.MAKE.DEPENDFILE:E} == "${TARGET_SPEC}"
235.if ${TARGET_SPEC} != ${MACHINE}
236.MAKE.DEPENDFILE_PREFERENCE += ${_CURDIR}/${.MAKE.DEPENDFILE:T:R}.$${MACHINE}
237.endif
238.MAKE.DEPENDFILE_PREFERENCE += ${_CURDIR}/${.MAKE.DEPENDFILE:T:R}
239.endif
240.endif
241
242_default_dependfile := ${.MAKE.DEPENDFILE_PREFERENCE:[1]:T}
243_machine_dependfiles := ${.MAKE.DEPENDFILE_PREFERENCE:T:M*${MACHINE}*}
244
245# for machine specific dependfiles we require ${MACHINE} to be at the end
246# also for the sake of sanity we require a common prefix
247.if !defined(.MAKE.DEPENDFILE_PREFIX)
248# knowing .MAKE.DEPENDFILE_PREFIX helps
249.if !empty(_machine_dependfiles)
250.MAKE.DEPENDFILE_PREFIX := ${_machine_dependfiles:[1]:T:R}
251.else
252.MAKE.DEPENDFILE_PREFIX := ${_default_dependfile:T}
253.endif
254.endif
255
256
257# this is how we identify non-machine specific dependfiles
258N_notmachine := ${.MAKE.DEPENDFILE_PREFERENCE:E:N*${MACHINE}*:${M_ListToSkip}}
259
260.endif				# !target(_DIRDEP_USE)
261
262# First off, we want to know what ${MACHINE} to build for.
263# This can be complicated if we are using a mixture of ${MACHINE} specific
264# and non-specific Makefile.depend*
265
266# if we were included recursively _DEP_TARGET_SPEC should be valid.
267.if empty(_DEP_TARGET_SPEC)
268DEP_MACHINE = ${TARGET_MACHINE:U${MACHINE}}
269_DEP_TARGET_SPEC := ${DEP_TARGET_SPEC}
270.if ${.INCLUDEDFROMFILE:U:M${.MAKE.DEPENDFILE_PREFIX}*} != ""
271# record that we've read dependfile for this
272_dirdeps_checked.${_CURDIR}.${TARGET_SPEC}:
273.endif
274.endif
275
276# by now _DEP_TARGET_SPEC should be set, parse it.
277.if ${TARGET_SPEC_VARS:[#]} > 1
278# we need to parse DEP_MACHINE may or may not contain more info
279_tspec := ${_DEP_TARGET_SPEC:S/,/ /g}
280.for i in ${_tspec_x}
281DEP_${TARGET_SPEC_VARS:[$i]} := ${_tspec:[$i]}
282.endfor
283.for v in ${TARGET_SPEC_VARS:O:u}
284.if empty(DEP_$v)
285.undef DEP_$v
286.endif
287.endfor
288.else
289DEP_MACHINE := ${_DEP_TARGET_SPEC}
290.endif
291
292# reset each time through
293_build_all_dirs =
294_build_xtra_dirs =
295
296# the first time we are included the _DIRDEP_USE target will not be defined
297# we can use this as a clue to do initialization and other one time things.
298.if !target(_DIRDEP_USE)
299# make sure this target exists
300dirdeps: beforedirdeps .WAIT
301beforedirdeps:
302
303# We normally expect to be included by Makefile.depend.*
304# which sets the DEP_* macros below.
305DEP_RELDIR ?= ${RELDIR}
306
307# this can cause lots of output!
308# set to a set of glob expressions that might match RELDIR
309DEBUG_DIRDEPS ?= no
310
311# remember the initial value of DEP_RELDIR - we test for it below.
312_DEP_RELDIR := ${DEP_RELDIR}
313
314.endif
315
316# DIRDEPS_CACHE can be very handy for debugging.
317# Also if repeatedly building the same target,
318# we can avoid the overhead of re-computing the tree dependencies.
319MK_DIRDEPS_CACHE ?= no
320BUILD_DIRDEPS_CACHE ?= no
321BUILD_DIRDEPS ?= yes
322
323.if ${MK_DIRDEPS_CACHE} == "yes"
324# this is where we will cache all our work
325DIRDEPS_CACHE ?= ${_OBJDIR:tA}/dirdeps.cache${_TARGETS:U${.TARGETS}:Nall:O:u:ts-:S,/,_,g:S,^,.,:N.}
326.endif
327
328.if ${DEBUG_DIRDEPS:@x@${DEP_RELDIR:M$x}${${DEP_RELDIR}.${DEP_MACHINE}:L:M$x}@} != ""
329_debug_reldir = 1
330.else
331_debug_reldir = 0
332.endif
333.if ${DEBUG_DIRDEPS:@x@${DEP_RELDIR:M$x}${${DEP_RELDIR}.depend:L:M$x}@} != ""
334_debug_search = 1
335.else
336_debug_search = 0
337.endif
338
339# pickup customizations
340# as below you can use !target(_DIRDEP_USE) to protect things
341# which should only be done once.
342.-include <local.dirdeps.mk>
343
344.if !target(_DIRDEP_USE)
345# things we skip for host tools
346SKIP_HOSTDIR ?=
347
348NSkipHostDir = ${SKIP_HOSTDIR:N*.host*:S,$,.host*,:N.host*:S,^,${SRCTOP}/,:${M_ListToSkip}}
349
350# things we always skip
351# SKIP_DIRDEPS allows for adding entries on command line.
352SKIP_DIR += .host *.WAIT ${SKIP_DIRDEPS}
353SKIP_DIR.host += ${SKIP_HOSTDIR}
354
355DEP_SKIP_DIR = ${SKIP_DIR} \
356	${SKIP_DIR.${DEP_TARGET_SPEC}:U} \
357	${TARGET_SPEC_VARS:@v@${SKIP_DIR.${DEP_$v}:U}@} \
358	${SKIP_DIRDEPS.${DEP_TARGET_SPEC}:U} \
359	${TARGET_SPEC_VARS:@v@${SKIP_DIRDEPS.${DEP_$v}:U}@}
360
361
362NSkipDir = ${DEP_SKIP_DIR:${M_ListToSkip}}
363
364.if defined(NODIRDEPS) || defined(WITHOUT_DIRDEPS)
365NO_DIRDEPS =
366.elif defined(WITHOUT_DIRDEPS_BELOW)
367NO_DIRDEPS_BELOW =
368.endif
369
370.if defined(NO_DIRDEPS)
371# confine ourselves to the original dir and below.
372DIRDEPS_FILTER += M${_DEP_RELDIR}*
373.elif defined(NO_DIRDEPS_BELOW)
374DIRDEPS_FILTER += M${_DEP_RELDIR}
375.endif
376
377# this is what we run below
378DIRDEP_MAKE ?= ${.MAKE}
379DIRDEP_DIR ?= ${.TARGET:R}
380
381# if you want us to report load averages during build
382# DIRDEP_USE_PRELUDE += ${DIRDEP_LOADAVG_REPORT};
383
384DIRDEP_LOADAVG_CMD ?= ${UPTIME:Uuptime} | sed 's,.*\(load\),\1,'
385DIRDEP_LOADAVG_LAST = 0
386# yes the expression here is a bit complicated,
387# the trick is to only eval ${DIRDEP_LOADAVG_LAST::=${now_utc}}
388# when we want to report.
389# Note: expr(1) will exit 1 if the expression evaluates to 0
390# hence the  || true
391DIRDEP_LOADAVG_REPORT = \
392	test -z "${"${expr ${now_utc} - ${DIRDEP_LOADAVG_INTEVAL:U60} - ${DIRDEP_LOADAVG_LAST} || true:L:sh:N-*}":?yes${DIRDEP_LOADAVG_LAST::=${now_utc}}:}" || \
393	echo "${TRACER}`${DIRDEP_LOADAVG_CMD}`"
394
395# we suppress SUBDIR when visiting the leaves
396# we assume sys.mk will set MACHINE_ARCH
397# you can add extras to DIRDEP_USE_ENV
398# if there is no makefile in the target directory, we skip it.
399_DIRDEP_USE:	.USE .MAKE
400	@for m in ${.MAKE.MAKEFILE_PREFERENCE}; do \
401		test -s ${.TARGET:R}/$$m || continue; \
402		echo "${TRACER}Checking ${.TARGET:S,${SRCTOP}/,,} for ${.TARGET:E} ..."; \
403		${DIRDEP_USE_PRELUDE} \
404		MACHINE_ARCH= NO_SUBDIR=1 ${DIRDEP_USE_ENV} \
405		TARGET_SPEC=${.TARGET:E} \
406		MACHINE=${.TARGET:E} \
407		${DIRDEP_MAKE} -C ${DIRDEP_DIR} || exit 1; \
408		break; \
409	done
410
411.ifdef ALL_MACHINES
412.if empty(ONLY_TARGET_SPEC_LIST) && empty(ONLY_MACHINE_LIST)
413# we start with everything
414_machine_list != echo; 'ls' -1 ${_CURDIR}/${.MAKE.DEPENDFILE_PREFIX}* 2> /dev/null
415
416# some things we know we want to ignore
417DIRDEPS_TARGETS_SKIP_LIST += \
418	*~ \
419	*.bak \
420	*.inc \
421	*.old \
422	*.options \
423	*.orig \
424	*.rej \
425
426# first trim things we know we want to skip
427# and provide canonical form
428_machine_list := ${_machine_list:${DIRDEPS_TARGETS_SKIP_LIST:${M_ListToSkip}}:T:E}
429
430# cater for local complexities
431# local.dirdeps.mk can set
432# DIRDEPS_ALL_MACHINES_FILTER and
433# DIRDEPS_ALL_MACHINES_FILTER_XTRAS for final tweaks
434
435.if !empty(ALL_TARGET_SPEC_LIST)
436.if ${_debug_reldir}
437.info ALL_TARGET_SPEC_LIST=${ALL_TARGET_SPEC_LIST}
438.endif
439DIRDEPS_ALL_MACHINES_FILTER += \
440	@x@$${ALL_TARGET_SPEC_LIST:@s@$${x:M$$s}@}@
441.elif !empty(ALL_MACHINE_LIST)
442.if ${_debug_reldir}
443.info ALL_MACHINE_LIST=${ALL_MACHINE_LIST}
444.endif
445.if ${TARGET_SPEC_VARS:[#]} > 1
446# the space below can result in extraneous ':'
447DIRDEPS_ALL_MACHINES_FILTER += \
448	@x@$${ALL_MACHINE_LIST:@m@$${x:M$$m,*} $${x:M$$m}@}@
449.else
450DIRDEPS_ALL_MACHINES_FILTER += \
451	@x@$${ALL_MACHINE_LIST:@m@$${x:M$$m}@}@
452.endif
453.endif
454# add local XTRAS - default to something benign
455DIRDEPS_ALL_MACHINES_FILTER += \
456	${DIRDEPS_ALL_MACHINES_FILTER_XTRAS:UNbak}
457
458.if ${_debug_reldir}
459.info _machine_list=${_machine_list}
460.info DIRDEPS_ALL_MACHINES_FILTER=${DIRDEPS_ALL_MACHINES_FILTER}
461.endif
462
463_only_machines := ${_machine_list:${DIRDEPS_ALL_MACHINES_FILTER:ts:}:S,:, ,g}
464.else
465_only_machines := ${ONLY_TARGET_SPEC_LIST:U} ${ONLY_MACHINE_LIST:U}
466.endif
467
468.if empty(_only_machines)
469# we must be boot-strapping
470_only_machines := ${TARGET_MACHINE:U${ALL_TARGET_SPEC_LIST:U${ALL_MACHINE_LIST:U${DEP_MACHINE}}}}
471.endif
472
473# cleanup the result
474_only_machines := ${_only_machines:O:u}
475
476.if ${_debug_reldir}
477.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: ALL_MACHINES _only_machines=${_only_machines}
478.endif
479
480.else				# ! ALL_MACHINES
481# if ONLY_TARGET_SPEC_LIST or ONLY_MACHINE_LIST is set, we are limited to that.
482# Note that ONLY_TARGET_SPEC_LIST should be fully qualified.
483# if TARGET_MACHINE is set - it is really the same as ONLY_MACHINE_LIST
484# otherwise DEP_MACHINE is it - so DEP_MACHINE will match.
485_only_machines := ${ONLY_TARGET_SPEC_LIST:U:M${DEP_MACHINE},*}
486.if empty(_only_machines)
487_only_machines := ${ONLY_MACHINE_LIST:U${TARGET_MACHINE:U${DEP_MACHINE}}:M${DEP_MACHINE}}
488.endif
489.endif
490
491.if !empty(NOT_MACHINE_LIST)
492_only_machines := ${_only_machines:${NOT_MACHINE_LIST:${M_ListToSkip}}}
493.endif
494.if !empty(NOT_TARGET_SPEC_LIST)
495# we must first qualify
496_dm := ${DEP_MACHINE}
497_only_machines := ${_only_machines:M*,*} ${_only_machines:N*,*:@DEP_MACHINE@${DEP_TARGET_SPEC}@:S,^,.,:${M_dep_qual_fixes:ts:}:O:u:S,^.,,}
498DEP_MACHINE := ${_dm}
499_only_machines := ${_only_machines:${NOT_TARGET_SPEC_LIST:${M_ListToSkip}}}
500.endif
501# clean up
502_only_machines := ${_only_machines:O:u}
503
504.if ${_debug_reldir}
505.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: _only_machines=${_only_machines}
506.endif
507
508# make sure we have a starting place?
509DIRDEPS ?= ${RELDIR}
510.endif				# target
511
512.if !defined(NO_DIRDEPS) && !defined(NO_DIRDEPS_BELOW)
513.if ${MK_DIRDEPS_CACHE} == "yes"
514
515# just ensure this exists
516build-dirdeps:
517
518M_oneperline = @x@\\${.newline}	$$x@
519
520.if ${BUILD_DIRDEPS_CACHE} == "no"
521.if !target(dirdeps-cached)
522# we do this via sub-make
523BUILD_DIRDEPS = no
524
525# ignore anything but these
526.MAKE.META.IGNORE_FILTER = M*/${.MAKE.DEPENDFILE_PREFIX}*
527
528dirdeps: dirdeps-cached
529dirdeps-cached:	${DIRDEPS_CACHE} .MAKE
530	@echo "${TRACER}Using ${DIRDEPS_CACHE}"
531	@MAKELEVEL=${.MAKE.LEVEL} ${.MAKE} -C ${_CURDIR} -f ${DIRDEPS_CACHE} \
532		dirdeps MK_DIRDEPS_CACHE=no BUILD_DIRDEPS=no
533
534# leaf makefiles rarely work for building DIRDEPS_CACHE
535.if ${RELDIR} != "."
536BUILD_DIRDEPS_MAKEFILE ?= -f dirdeps.mk
537.endif
538
539# these should generally do
540BUILD_DIRDEPS_MAKEFILE ?=
541BUILD_DIRDEPS_TARGETS ?= ${.TARGETS}
542
543.if ${DIRDEPS_CACHE} != ${STATIC_DIRDEPS_CACHE:Uno} && ${DIRDEPS_CACHE:M${SRCTOP}/*} == ""
544# export this for dirdeps-cache-update.mk
545DYNAMIC_DIRDEPS_CACHE := ${DIRDEPS_CACHE}
546.export DYNAMIC_DIRDEPS_CACHE
547# we need the .meta file to ensure we update if
548# any of the Makefile.depend* changed.
549# We do not want to compare the command line though.
550${DIRDEPS_CACHE}:	.META .NOMETA_CMP
551	+@{ echo '# Autogenerated - do NOT edit!'; echo; \
552	echo 'BUILD_DIRDEPS=no'; echo; \
553	echo '.include <dirdeps.mk>'; echo; \
554	} > ${.TARGET}.new
555	+@MAKELEVEL=${.MAKE.LEVEL} DIRDEPS_CACHE=${DIRDEPS_CACHE} \
556	DIRDEPS="${DIRDEPS}" \
557	TARGET_SPEC=${TARGET_SPEC} \
558	MAKEFLAGS= ${DIRDEP_CACHE_MAKE:U${.MAKE}} -C ${_CURDIR} \
559	${BUILD_DIRDEPS_MAKEFILE} \
560	${BUILD_DIRDEPS_TARGETS} BUILD_DIRDEPS_CACHE=yes \
561	.MAKE.DEPENDFILE=.none \
562	${"${DEBUG_DIRDEPS:Nno}":?DEBUG_DIRDEPS='${DEBUG_DIRDEPS}':} \
563	${.MAKEFLAGS:tW:S,-D ,-D,g:tw:M*WITH*} \
564	${.MAKEFLAGS:tW:S,-d ,-d,g:tw:M-d*} \
565	3>&1 1>&2 | sed 's,${SRCTOP},$${SRCTOP},g;s,_{,$${,g' >> ${.TARGET}.new && \
566	mv ${.TARGET}.new ${.TARGET}
567
568.endif
569.endif
570.elif !target(_count_dirdeps)
571# we want to capture the dirdeps count in the cache
572.END: _count_dirdeps
573_count_dirdeps: .NOMETA
574	@{ echo; echo '.info $${.newline}$${TRACER}Makefiles read: total=${.MAKE.MAKEFILES:[#]} depend=${.MAKE.MAKEFILES:M*depend*:[#]} dirdeps=${.ALLTARGETS:M${SRCTOP}*:O:u:[#]} ${DIRDEP_INFO_XTRAS}'; } >&3
575
576.endif
577.elif !make(dirdeps) && !target(_count_dirdeps)
578beforedirdeps: _count_dirdeps
579_count_dirdeps: .NOMETA
580	@echo "${TRACER}Makefiles read: total=${.MAKE.MAKEFILES:[#]} depend=${.MAKE.MAKEFILES:M*depend*:[#]} dirdeps=${.ALLTARGETS:M${SRCTOP}*:O:u:[#]} ${DIRDEP_INFO_XTRAS} seconds=`expr ${now_utc} - ${start_utc}`"
581
582.endif
583.endif
584
585.if ${BUILD_DIRDEPS} == "yes"
586
587# the rest is done repeatedly for every Makefile.depend we read.
588# if we are anything but the original dir we care only about the
589# machine type we were included for..
590
591.if ${DEP_RELDIR} == "."
592_this_dir := ${SRCTOP}
593.else
594_this_dir := ${SRCTOP}/${DEP_RELDIR}
595.endif
596
597# on rare occasions, there can be a need for extra help
598_dep_hack := ${_this_dir}/${.MAKE.DEPENDFILE_PREFIX}.inc
599.-include <${_dep_hack}>
600.-include <${_dep_hack:R}.options>
601
602.if ${DEP_RELDIR} != ${_DEP_RELDIR} || ${DEP_TARGET_SPEC} != ${TARGET_SPEC}
603# this should be all
604_machines := ${DEP_MACHINE}
605.else
606# this is the machine list we actually use below
607_machines := ${_only_machines}
608
609.if defined(HOSTPROG) || ${DEP_MACHINE:Nhost*} == ""
610# we need to build this guy's dependencies for host as well.
611.if ${DEP_MACHINE:Nhost*} == ""
612_machines += ${DEP_MACHINE}
613.else
614_machines += host
615.endif
616.endif
617
618_machines := ${_machines:O:u}
619.endif
620
621.if ${TARGET_SPEC_VARS:[#]} > 1
622# we need to tweak _machines
623_dm := ${DEP_MACHINE}
624# apply the same filtering that we do when qualifying DIRDEPS.
625# M_dep_qual_fixes expects .${MACHINE}* so add (and remove) '.'
626# Again we expect that any already qualified machines are fully qualified.
627_machines := ${_machines:M*,*} ${_machines:N*,*:@DEP_MACHINE@${DEP_TARGET_SPEC}@:S,^,.,:${M_dep_qual_fixes:ts:}:O:u:S,^.,,}
628DEP_MACHINE := ${_dm}
629_machines := ${_machines:O:u}
630.endif
631
632# reset each time through
633_build_dirs =
634
635.if ${DEP_RELDIR} == ${_DEP_RELDIR}
636# pickup other machines for this dir if necessary
637_build_dirs += ${_machines:@m@${_CURDIR}.$m@}
638.endif
639
640.if ${_debug_reldir}
641.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: DIRDEPS='${DIRDEPS}'
642.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: _machines='${_machines}'
643.endif
644
645.if !empty(DIRDEPS)
646# these we reset each time through as they can depend on DEP_MACHINE
647DEP_DIRDEPS_FILTER = \
648	${DIRDEPS_FILTER.${DEP_TARGET_SPEC}:U} \
649	${TARGET_SPEC_VARS:@v@${DIRDEPS_FILTER.${DEP_$v}:U}@} \
650	${DIRDEPS_FILTER:U}
651.if empty(DEP_DIRDEPS_FILTER)
652# something harmless
653DEP_DIRDEPS_FILTER = U
654.endif
655
656# this is what we start with
657__depdirs := ${DIRDEPS:${NSkipDir}:${DEP_DIRDEPS_FILTER:ts:}:C,//+,/,g:O:u:@d@${SRCTOP}/$d@}
658
659# some entries may be qualified with .<machine>
660# the :M*/*/*.* just tries to limit the dirs we check to likely ones.
661# the ${d:E:M*/*} ensures we don't consider junos/usr.sbin/mgd
662__qual_depdirs := ${__depdirs:M*/*/*.*:@d@${exists($d):?:${"${d:E:M*/*}":?:${exists(${d:R}):?$d:}}}@}
663__unqual_depdirs := ${__depdirs:${__qual_depdirs:Uno:${M_ListToSkip}}}
664
665.if ${DEP_RELDIR} == ${_DEP_RELDIR}
666# if it was called out - we likely need it.
667__hostdpadd := ${DPADD:U.:M${HOST_OBJTOP}/*:S,${HOST_OBJTOP}/,,:H:${NSkipDir}:${DIRDEPS_FILTER:ts:}:S,$,.host,:N.*:@d@${SRCTOP}/$d@} \
668	${DPADD:U.:M${HOST_OBJTOP32:Uno}/*:S,${HOST_OBJTOP32:Uno}/,,:H:${NSkipDir}:${DIRDEPS_FILTER:ts:}:S,$,.host32,:N.*:@d@${SRCTOP}/$d@}
669__qual_depdirs += ${__hostdpadd}
670.endif
671
672.if ${_debug_reldir}
673.info DEP_DIRDEPS_FILTER=${DEP_DIRDEPS_FILTER:ts:}
674.info depdirs=${__depdirs}
675.info qualified=${__qual_depdirs}
676.info unqualified=${__unqual_depdirs}
677.endif
678
679# _build_dirs is what we will feed to _DIRDEP_USE
680_build_dirs += \
681	${__qual_depdirs:M*.host:${NSkipHostDir}:N.host} \
682	${__qual_depdirs:N*.host} \
683	${_machines:Mhost*:@m@${__unqual_depdirs:@d@$d.$m@}@:${NSkipHostDir}:N.host} \
684	${_machines:Nhost*:@m@${__unqual_depdirs:@d@$d.$m@}@}
685
686# qualify everything now
687_build_dirs := ${_build_dirs:${M_dep_qual_fixes:ts:}:O:u}
688
689.endif				# empty DIRDEPS
690
691_build_all_dirs += ${_build_dirs} ${_build_xtra_dirs}
692_build_all_dirs := ${_build_all_dirs:O:u}
693
694# Normally if doing make -V something,
695# we do not want to waste time chasing DIRDEPS
696# but if we want to count the number of Makefile.depend* read, we do.
697.if ${.MAKEFLAGS:M-V${_V_READ_DIRDEPS}} == ""
698.if !empty(_build_all_dirs)
699.if ${BUILD_DIRDEPS_CACHE} == "yes"
700x!= echo; { echo; echo '\# ${DEP_RELDIR}.${DEP_TARGET_SPEC}'; } >&3
701# guard against _new_dirdeps being too big for a single command line
702_new_dirdeps := ${_build_all_dirs:@x@${target($x):?:$x}@}
703.export _build_xtra_dirs _new_dirdeps
704.if !empty(DEP_EXPORT_VARS)
705# Discouraged, but there are always exceptions.
706# Handle it here rather than explain how.
707x!= echo; { echo; ${DEP_EXPORT_VARS:@v@echo '$v=${$v}';@} echo '.export ${DEP_EXPORT_VARS}'; echo; } >&3
708.endif
709.else
710# this makes it all happen
711dirdeps: ${_build_all_dirs}
712.endif
713${_build_all_dirs}:	_DIRDEP_USE
714
715.if ${_debug_reldir}
716.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: needs: ${_build_dirs}
717.endif
718
719.if !empty(DEP_EXPORT_VARS)
720.export ${DEP_EXPORT_VARS}
721DEP_EXPORT_VARS=
722.endif
723
724# this builds the dependency graph
725.for m in ${_machines}
726.if ${BUILD_DIRDEPS_CACHE} == "yes" && !empty(_build_dirs)
727x!= echo; { echo; echo 'DIRDEPS.${_this_dir}.$m = \'; } >&3
728_cache_deps =
729.endif
730# it would be nice to do :N${.TARGET}
731.if !empty(__qual_depdirs)
732.for q in ${__qual_depdirs:${M_dep_qual_fixes:ts:}:E:O:u:N$m}
733.if ${_debug_reldir} || ${DEBUG_DIRDEPS:@x@${${DEP_RELDIR}.$m:L:M$x}${${DEP_RELDIR}.$q:L:M$x}@} != ""
734.info ${DEP_RELDIR}.$m: graph: ${_build_dirs:M*.$q}
735.endif
736.if ${BUILD_DIRDEPS_CACHE} == "yes"
737_cache_deps += ${_build_dirs:M*.$q}
738.else
739${_this_dir}.$m: ${_build_dirs:M*.$q}
740.endif
741.endfor
742.endif
743.if ${_debug_reldir}
744.info ${DEP_RELDIR}.$m: graph: ${_build_dirs:M*.$m:N${_this_dir}.$m}
745.endif
746.if ${BUILD_DIRDEPS_CACHE} == "yes"
747.if !empty(_build_dirs)
748_cache_deps += ${_build_dirs:M*.$m:N${_this_dir}.$m}
749.if !empty(_cache_deps)
750.export _cache_deps
751x!= echo; for x in $$_cache_deps; do echo "	$$x \\"; done >&3
752.endif
753# anything in _build_xtra_dirs is hooked to dirdeps: only
754x!= echo; { echo; echo '${_this_dir}.$m: $${DIRDEPS.${_this_dir}.$m}'; \
755	echo; echo 'dirdeps: ${_this_dir}.$m \'; \
756	for x in $$_build_xtra_dirs; do echo "	$$x \\"; done; \
757	echo; for x in $$_new_dirdeps; do echo "$$x: _DIRDEP_USE"; done; } >&3
758.endif
759.else
760${_this_dir}.$m: ${_build_dirs:M*.$m:N${_this_dir}.$m}
761.endif
762.endfor
763
764.endif
765
766# Now find more dependencies - and recurse.
767.for d in ${_build_all_dirs}
768.if !target(_dirdeps_checked.$d)
769# once only
770_dirdeps_checked.$d:
771.if ${_debug_search}
772.info checking $d
773.endif
774# Note: _build_all_dirs is fully qualifed so d:R is always the directory
775.if exists(${d:R})
776# we pass _DEP_TARGET_SPEC to tell the next step what we want
777_DEP_TARGET_SPEC := ${d:E}
778# some makefiles may still look at this
779_DEP_MACHINE := ${d:E:C/,.*//}
780# set these too in case Makefile.depend* uses them
781.if ${TARGET_SPEC_VARS:[#]} > 1
782_dtspec := ${_DEP_TARGET_SPEC:S/,/ /g}
783.for i in ${_tspec_x}
784DEP_${TARGET_SPEC_VARS:[$i]} := ${_dtspec:[$i]}
785.endfor
786.else
787DEP_MACHINE := ${_DEP_MACHINE}
788.endif
789# Warning: there is an assumption here that MACHINE is always
790# the first entry in TARGET_SPEC_VARS.
791# If TARGET_SPEC and MACHINE are insufficient, you have a problem.
792_m := ${.MAKE.DEPENDFILE_PREFERENCE:T:S;${TARGET_SPEC}$;${d:E};:C;${MACHINE}((,.+)?)$;${d:E:C/,.*//}\1;:@m@${exists(${d:R}/$m):?${d:R}/$m:}@:[1]}
793.if !empty(_m)
794# M_dep_qual_fixes isn't geared to Makefile.depend
795_qm := ${_m:C;(\.depend)$;\1.${d:E};:${M_dep_qual_fixes:ts:}}
796.if ${_debug_search}
797.info Looking for ${_qm}
798.endif
799# set this "just in case"
800# we can skip :tA since we computed the path above
801DEP_RELDIR := ${_m:H:S,${SRCTOP}/,,}
802# and reset this
803DIRDEPS =
804.if ${_debug_reldir} && ${_qm} != ${_m}
805.info loading ${_m} for ${d:E}
806.endif
807.include <${_m}>
808.else
809.-include <local.dirdeps-missing.mk>
810.endif
811.endif
812.endif
813.endfor
814
815.endif				# -V
816.endif				# BUILD_DIRDEPS
817
818.elif ${.MAKE.LEVEL} > 42
819.error You should have stopped recursing by now.
820.else
821# we are building something
822DEP_RELDIR := ${RELDIR}
823_DEP_RELDIR := ${RELDIR}
824# Since we are/should be included by .MAKE.DEPENDFILE
825# This is a final opportunity to add/hook global rules.
826.-include <local.dirdeps-build.mk>
827
828# skip _reldir_{finish,failed} if not included from Makefile.depend*
829# or not in meta mode
830.if !defined(WITHOUT_META_STATS) && ${.INCLUDEDFROMFILE:U:M${.MAKE.DEPENDFILE_PREFIX}*} != "" && ${.MAKE.MODE:Mmeta} != ""
831
832meta_stats= meta=${empty(.MAKE.META.FILES):?0:${.MAKE.META.FILES:[#]}} \
833	created=${empty(.MAKE.META.CREATED):?0:${.MAKE.META.CREATED:[#]}}
834
835.if !target(_reldir_finish)
836.END: _reldir_finish
837_reldir_finish: .NOMETA
838	@echo "${TRACER}Finished ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
839.endif
840
841.if !target(_reldir_failed)
842.ERROR: _reldir_failed
843_reldir_failed: .NOMETA
844	@echo "${TRACER}Failed ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
845.endif
846
847.endif
848
849# pickup local dependencies
850.if ${MAKE_VERSION} < 20160220
851.-include <.depend>
852.else
853.dinclude <.depend>
854.endif
855.endif
856
857# bootstrapping new dependencies made easy?
858.if !target(bootstrap-empty)
859.if !target(bootstrap) && (make(bootstrap) || \
860	make(bootstrap-this) || \
861	make(bootstrap-recurse) || \
862	make(bootstrap-empty))
863
864# if we are bootstrapping create the default
865_want = ${.CURDIR}/${.MAKE.DEPENDFILE_DEFAULT:T}
866
867.if exists(${_want})
868# stop here
869${.TARGETS:Mboot*}:
870.elif !make(bootstrap-empty)
871# find a Makefile.depend to use as _src
872_src != cd ${.CURDIR} && for m in ${.MAKE.DEPENDFILE_PREFERENCE:T:S,${MACHINE},*,}; do test -s $$m || continue; echo $$m; break; done; echo
873.if empty(_src)
874.error cannot find any of ${.MAKE.DEPENDFILE_PREFERENCE:T}${.newline}Use: bootstrap-empty
875.endif
876
877_src?= ${.MAKE.DEPENDFILE}
878
879.MAKE.DEPENDFILE_BOOTSTRAP_SED+= -e 's/${_src:E:C/,.*//}/${MACHINE}/g'
880
881# just create Makefile.depend* for this dir
882bootstrap-this:	.NOTMAIN
883	@echo Bootstrapping ${RELDIR}/${_want:T} from ${_src:T}; \
884	echo You need to build ${RELDIR} to correctly populate it.
885.if ${_src:T} != ${.MAKE.DEPENDFILE_PREFIX:T}
886	(cd ${.CURDIR} && sed ${.MAKE.DEPENDFILE_BOOTSTRAP_SED} ${_src} > ${_want:T})
887.else
888	cp ${.CURDIR}/${_src:T} ${_want}
889.endif
890
891# create Makefile.depend* for this dir and its dependencies
892bootstrap: bootstrap-recurse
893bootstrap-recurse: bootstrap-this
894
895_mf := ${.PARSEFILE}
896bootstrap-recurse:	.NOTMAIN .MAKE
897	@cd ${SRCTOP} && \
898	for d in `cd ${RELDIR} && ${.MAKE} -B -f ${"${.MAKEFLAGS:M-n}":?${_src}:${.MAKE.DEPENDFILE:T}} -V DIRDEPS`; do \
899		test -d $$d || d=$${d%.*}; \
900		test -d $$d || continue; \
901		echo "Checking $$d for bootstrap ..."; \
902		(cd $$d && ${.MAKE} -f ${_mf} bootstrap-recurse); \
903	done
904
905.endif
906
907# create an empty Makefile.depend* to get the ball rolling.
908bootstrap-empty: .NOTMAIN .NOMETA
909	@echo Creating empty ${RELDIR}/${_want:T}; \
910	echo You need to build ${RELDIR} to correctly populate it.
911	@{ echo DIRDEPS=; echo ".include <dirdeps.mk>"; } > ${_want}
912
913.endif
914.endif
915