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