xref: /freebsd/share/mk/dirdeps.mk (revision dd4f32ae62426a10a84b4322756d82c06c202c4e)
1# $Id: dirdeps.mk,v 1.160 2023/05/10 20:44:58 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# turn a list into a set of :N modifiers
277# NskipFoo = ${Foo:${M_ListToSkip}}
278M_ListToSkip ?= O:u:S,^,N,:ts:
279
280# this is how we identify non-machine specific dependfiles
281N_notmachine := ${.MAKE.DEPENDFILE_PREFERENCE:E:N*${MACHINE}*:${M_ListToSkip}}
282
283# this gets reset for each dirdep we check
284DEP_RELDIR ?= ${RELDIR}
285
286# remember the initial value of DEP_RELDIR - we test for it below.
287_DEP_RELDIR := ${DEP_RELDIR}
288
289# this can cause lots of output!
290# set to a set of glob expressions that might match RELDIR
291DEBUG_DIRDEPS ?= no
292
293# make sure this target exists
294dirdeps: beforedirdeps .WAIT
295beforedirdeps:
296
297.endif				# !target(_DIRDEP_USE)
298
299.if ${DEBUG_DIRDEPS:@x@${DEP_RELDIR:M$x}${${DEP_RELDIR}.${DEP_MACHINE}:L:M$x}@} != ""
300_debug_reldir = 1
301.else
302_debug_reldir = 0
303.endif
304.if ${DEBUG_DIRDEPS:@x@${DEP_RELDIR:M$x}${${DEP_RELDIR}.depend depend:L:M$x}@} != ""
305_debug_search = 1
306.else
307_debug_search = 0
308.endif
309
310# First off, we want to know what ${MACHINE} to build for.
311# This can be complicated if we are using a mixture of ${MACHINE} specific
312# and non-specific Makefile.depend*
313
314# if we were included recursively _DEP_TARGET_SPEC should be valid.
315.if empty(_DEP_TARGET_SPEC)
316DEP_MACHINE = ${TARGET_MACHINE:U${MACHINE}}
317_DEP_TARGET_SPEC := ${DEP_TARGET_SPEC}
318.if ${.INCLUDEDFROMFILE:U:M${.MAKE.DEPENDFILE_PREFIX}*} != ""
319# record that we've read dependfile for this
320_dirdeps_checked.${_CURDIR}.${TARGET_SPEC}:
321.endif
322.endif
323
324# by now _DEP_TARGET_SPEC should be set, parse it.
325.if ${TARGET_SPEC_VARS:[#]} > 1
326# we need to parse DEP_MACHINE may or may not contain more info
327_tspec := ${_DEP_TARGET_SPEC:S/,/ /g}
328.for i in ${_tspec_x}
329DEP_${TARGET_SPEC_VARS:[$i]} := ${_tspec:[$i]}
330.endfor
331.for v in ${TARGET_SPEC_VARS:O:u}
332.if empty(DEP_$v)
333.undef DEP_$v
334.endif
335.endfor
336.else
337DEP_MACHINE := ${_DEP_TARGET_SPEC}
338.endif
339
340# host is special
341.if ${DEP_MACHINE:Mhost*} != ""
342DEP_TARGET_SPEC = ${DEP_MACHINE}
343.for v in ${TARGET_SPEC_VARS:O:u:NMACHINE}
344.undef DEP_$v
345.endfor
346.endif
347
348# reset each time through
349_build_all_dirs =
350_build_xtra_dirs =
351
352# DIRDEPS_CACHE can be very handy for debugging.
353# Also if repeatedly building the same target,
354# we can avoid the overhead of re-computing the tree dependencies.
355MK_DIRDEPS_CACHE ?= no
356BUILD_DIRDEPS_CACHE ?= no
357BUILD_DIRDEPS ?= yes
358
359.if ${MK_DIRDEPS_CACHE} == "yes"
360# this is where we will cache all our work
361DIRDEPS_CACHE ?= ${_OBJDIR:tA}/dirdeps.cache${_TARGETS:U${.TARGETS}:Nall:O:u:ts-:S,/,_,g:S,^,.,:N.}
362.endif
363
364# sanity check: Makefile.depend.options should *not* include us
365.if ${.INCLUDEDFROMFILE:U:M${.MAKE.DEPENDFILE_PREFIX}.options} != ""
366.error ${DEP_RELDIR}/${.MAKE.DEPENDFILE_PREFIX}.options: should include dirdeps-options.mk
367.endif
368
369# pickup customizations
370# as below you can use !target(_DIRDEP_USE) to protect things
371# which should only be done once.
372.-include <local.dirdeps.mk>
373
374.if !target(_DIRDEP_USE)
375# things we skip for host tools
376SKIP_HOSTDIR ?=
377
378NSkipHostDir = ${SKIP_HOSTDIR:N*.host*:S,$,.host*,:N.host*:S,^,${SRCTOP}/,:${M_ListToSkip}}
379
380# things we always skip
381# SKIP_DIRDEPS allows for adding entries on command line.
382SKIP_DIR += .host *.WAIT ${SKIP_DIRDEPS}
383SKIP_DIR.host += ${SKIP_HOSTDIR}
384
385DEP_SKIP_DIR = ${SKIP_DIR} \
386	${SKIP_DIR.${DEP_TARGET_SPEC}:U} \
387	${TARGET_SPEC_VARS:@v@${SKIP_DIR.${DEP_$v}:U}@} \
388	${SKIP_DIRDEPS.${DEP_TARGET_SPEC}:U} \
389	${TARGET_SPEC_VARS:@v@${SKIP_DIRDEPS.${DEP_$v}:U}@}
390
391
392NSkipDir = ${DEP_SKIP_DIR:${M_ListToSkip}}
393
394.if defined(NODIRDEPS) || defined(WITHOUT_DIRDEPS)
395NO_DIRDEPS =
396.elif defined(WITHOUT_DIRDEPS_BELOW)
397NO_DIRDEPS_BELOW =
398.endif
399
400.if defined(NO_DIRDEPS)
401# confine ourselves to the original dir and below.
402DIRDEPS_FILTER += M${_DEP_RELDIR}*
403.elif defined(NO_DIRDEPS_BELOW)
404DIRDEPS_FILTER += M${_DEP_RELDIR}
405.endif
406
407# this is what we run below
408DIRDEP_MAKE ?= ${.MAKE}
409DIRDEP_DIR ?= ${.TARGET:R}
410
411# if you want us to report load averages during build
412# DIRDEP_USE_PRELUDE += ${DIRDEP_LOADAVG_REPORT};
413
414DIRDEP_LOADAVG_CMD ?= ${UPTIME:Uuptime} | sed 's,.*\(load\),\1,'
415DIRDEP_LOADAVG_LAST = 0
416# yes the expression here is a bit complicated,
417# the trick is to only eval ${DIRDEP_LOADAVG_LAST::=${now_utc}}
418# when we want to report.
419# Note: expr(1) will exit 1 if the expression evaluates to 0
420# hence the  || true
421DIRDEP_LOADAVG_REPORT = \
422	test -z "${"${expr ${now_utc} - ${DIRDEP_LOADAVG_INTERVAL:U60} - ${DIRDEP_LOADAVG_LAST} || true:L:sh:N-*}":?yes${DIRDEP_LOADAVG_LAST::=${now_utc}}:}" || \
423	echo "${TRACER}`${DIRDEP_LOADAVG_CMD}`"
424
425# we suppress SUBDIR when visiting the leaves
426# we assume sys.mk will set MACHINE_ARCH
427# you can add extras to DIRDEP_USE_ENV
428# if there is no makefile in the target directory, we skip it.
429_DIRDEP_USE:	.USE .MAKE
430	@for m in ${.MAKE.MAKEFILE_PREFERENCE}; do \
431		test -s ${.TARGET:R}/$$m || continue; \
432		echo "${TRACER}Checking ${.TARGET:S,^${SRCTOP}/,,} for ${.TARGET:E} ..."; \
433		${DIRDEP_USE_PRELUDE} \
434		MACHINE_ARCH= NO_SUBDIR=1 ${DIRDEP_USE_ENV} \
435		TARGET_SPEC=${.TARGET:E} \
436		MACHINE=${.TARGET:E} \
437		${DIRDEP_MAKE} -C ${DIRDEP_DIR} || exit 1; \
438		break; \
439	done
440
441.ifdef ALL_MACHINES
442.if empty(ONLY_TARGET_SPEC_LIST) && empty(ONLY_MACHINE_LIST)
443# we start with everything
444_machine_list != echo; 'ls' -1 ${_CURDIR}/${.MAKE.DEPENDFILE_PREFIX}* 2> /dev/null
445
446# some things we know we want to ignore
447DIRDEPS_TARGETS_SKIP_LIST += \
448	*~ \
449	*.bak \
450	*.inc \
451	*.old \
452	*.options \
453	*.orig \
454	*.rej \
455
456# first trim things we know we want to skip
457# and provide canonical form
458_machine_list := ${_machine_list:${DIRDEPS_TARGETS_SKIP_LIST:${M_ListToSkip}}:T:E}
459
460# cater for local complexities
461# local.dirdeps.mk can set
462# DIRDEPS_ALL_MACHINES_FILTER and
463# DIRDEPS_ALL_MACHINES_FILTER_XTRAS for final tweaks
464
465.if !empty(ALL_TARGET_SPEC_LIST)
466.if ${_debug_reldir}
467.info ALL_TARGET_SPEC_LIST=${ALL_TARGET_SPEC_LIST}
468.endif
469DIRDEPS_ALL_MACHINES_FILTER += \
470	@x@$${ALL_TARGET_SPEC_LIST:@s@$${x:M$$s}@}@
471.elif !empty(ALL_MACHINE_LIST)
472.if ${_debug_reldir}
473.info ALL_MACHINE_LIST=${ALL_MACHINE_LIST}
474.endif
475.if ${TARGET_SPEC_VARS:[#]} > 1
476# the space below can result in extraneous ':'
477DIRDEPS_ALL_MACHINES_FILTER += \
478	@x@$${ALL_MACHINE_LIST:@m@$${x:M$$m,*} $${x:M$$m}@}@
479.else
480DIRDEPS_ALL_MACHINES_FILTER += \
481	@x@$${ALL_MACHINE_LIST:@m@$${x:M$$m}@}@
482.endif
483.endif
484# add local XTRAS - default to something benign
485DIRDEPS_ALL_MACHINES_FILTER += \
486	${DIRDEPS_ALL_MACHINES_FILTER_XTRAS:UNbak}
487
488.if ${_debug_reldir}
489.info _machine_list=${_machine_list}
490.info DIRDEPS_ALL_MACHINES_FILTER=${DIRDEPS_ALL_MACHINES_FILTER}
491.endif
492
493_only_machines := ${_machine_list:${DIRDEPS_ALL_MACHINES_FILTER:ts:}:S,:, ,g}
494.else
495_only_machines := ${ONLY_TARGET_SPEC_LIST:U} ${ONLY_MACHINE_LIST:U}
496.endif
497
498.if empty(_only_machines)
499# we must be boot-strapping
500_only_machines := ${TARGET_MACHINE:U${ALL_TARGET_SPEC_LIST:U${ALL_MACHINE_LIST:U${DEP_MACHINE}}}}
501.endif
502
503# cleanup the result
504_only_machines := ${_only_machines:O:u}
505
506.if ${_debug_reldir}
507.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: ALL_MACHINES _only_machines=${_only_machines}
508.endif
509
510.else				# ! ALL_MACHINES
511# if ONLY_TARGET_SPEC_LIST or ONLY_MACHINE_LIST is set, we are limited to that.
512# Note that ONLY_TARGET_SPEC_LIST should be fully qualified.
513# if TARGET_MACHINE is set - it is really the same as ONLY_MACHINE_LIST
514# otherwise DEP_MACHINE is it - so DEP_MACHINE will match.
515_only_machines := ${ONLY_TARGET_SPEC_LIST:U:M${DEP_MACHINE},*}
516.if empty(_only_machines)
517_only_machines := ${ONLY_MACHINE_LIST:U${TARGET_MACHINE:U${DEP_MACHINE}}:M${DEP_MACHINE}}
518.endif
519.endif
520
521.if !empty(NOT_MACHINE_LIST)
522_only_machines := ${_only_machines:${NOT_MACHINE_LIST:${M_ListToSkip}}}
523.endif
524.if !empty(NOT_TARGET_SPEC_LIST)
525# we must first qualify
526_dm := ${DEP_MACHINE}
527_only_machines := ${_only_machines:M*,*} ${_only_machines:N*,*:@DEP_MACHINE@${DEP_TARGET_SPEC}@:S,^,.,:${M_dep_qual_fixes:ts:}:O:u:S,^.,,}
528DEP_MACHINE := ${_dm}
529_only_machines := ${_only_machines:${NOT_TARGET_SPEC_LIST:${M_ListToSkip}}}
530.endif
531# clean up
532_only_machines := ${_only_machines:O:u}
533
534.if ${_debug_reldir}
535.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: _only_machines=${_only_machines}
536.endif
537
538# make sure we have a starting place?
539DIRDEPS ?= ${RELDIR}
540.endif				# target
541
542.if !defined(NO_DIRDEPS) && !defined(NO_DIRDEPS_BELOW)
543.if ${MK_DIRDEPS_CACHE} == "yes"
544
545# just ensure this exists
546build-dirdeps:
547
548M_oneperline = @x@\\${.newline}	$$x@
549
550.if ${BUILD_DIRDEPS_CACHE} == "no"
551.if !target(dirdeps-cached)
552# we do this via sub-make
553BUILD_DIRDEPS = no
554
555# ignore anything but these
556.MAKE.META.IGNORE_FILTER = M*/${.MAKE.DEPENDFILE_PREFIX}*
557
558dirdeps: dirdeps-cached
559dirdeps-cached:	${DIRDEPS_CACHE} .MAKE
560	@echo "${TRACER}Using ${DIRDEPS_CACHE}"
561	@MAKELEVEL=${.MAKE.LEVEL} \
562	TARGET_SPEC=${TARGET_SPEC} \
563	${TARGET_SPEC_VARS:@v@$v=${$v}@} \
564	${.MAKE} -C ${_CURDIR} -f ${DIRDEPS_CACHE} \
565		dirdeps MK_DIRDEPS_CACHE=no BUILD_DIRDEPS=no
566
567# leaf makefiles rarely work for building DIRDEPS_CACHE
568.if ${RELDIR} != "."
569BUILD_DIRDEPS_MAKEFILE ?= -f dirdeps.mk
570.endif
571
572# these should generally do
573BUILD_DIRDEPS_MAKEFILE ?=
574BUILD_DIRDEPS_TARGETS ?= ${.TARGETS}
575
576.if ${DIRDEPS_CACHE} != ${STATIC_DIRDEPS_CACHE:Uno} && ${DIRDEPS_CACHE:M${SRCTOP}/*} == ""
577# export this for dirdeps-cache-update.mk
578DYNAMIC_DIRDEPS_CACHE := ${DIRDEPS_CACHE}
579.export DYNAMIC_DIRDEPS_CACHE
580# we need the .meta file to ensure we update if
581# any of the Makefile.depend* changed.
582# We do not want to compare the command line though.
583${DIRDEPS_CACHE}:	.META .NOMETA_CMP
584	+@{ echo '# Autogenerated - do NOT edit!'; echo; \
585	echo 'BUILD_DIRDEPS=no'; echo; \
586	echo '.include <dirdeps.mk>'; echo; \
587	} > ${.TARGET}.new
588	+@MAKELEVEL=${.MAKE.LEVEL} DIRDEPS_CACHE=${DIRDEPS_CACHE} \
589	DIRDEPS="${DIRDEPS}" \
590	TARGET_SPEC=${TARGET_SPEC} \
591	MAKEFLAGS= ${DIRDEP_CACHE_MAKE:U${.MAKE}} -C ${_CURDIR} \
592	${BUILD_DIRDEPS_MAKEFILE} \
593	${BUILD_DIRDEPS_TARGETS} BUILD_DIRDEPS_CACHE=yes \
594	.MAKE.DEPENDFILE=.none \
595	${"${DEBUG_DIRDEPS:Nno}":?DEBUG_DIRDEPS='${DEBUG_DIRDEPS}':} \
596	${.MAKEFLAGS:tW:S,-D ,-D,g:tw:M*WITH*} \
597	${.MAKEFLAGS:tW:S,-d ,-d,g:tw:M-d*} \
598	3>&1 1>&2 | sed 's,${SRCTOP},_{SRCTOP},g;s,_{SRCTOP}/_{SRCTOP},_{SRCTOP},g;s,_{,$${,g' >> ${.TARGET}.new && \
599	mv ${.TARGET}.new ${.TARGET}
600
601.endif
602.endif
603.elif !target(_count_dirdeps)
604# we want to capture the dirdeps count in the cache
605.END: _count_dirdeps
606_count_dirdeps: .NOMETA
607	@{ 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
608
609.endif
610.elif !make(dirdeps) && !target(_count_dirdeps)
611beforedirdeps: _count_dirdeps
612_count_dirdeps: .NOMETA
613	@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}`"
614
615.endif
616.endif
617
618.if ${BUILD_DIRDEPS} == "yes"
619
620# the rest is done repeatedly for every Makefile.depend we read.
621# if we are anything but the original dir we care only about the
622# machine type we were included for..
623
624.if ${DEP_RELDIR} == "."
625_this_dir := ${SRCTOP}
626.else
627_this_dir := ${SRCTOP}/${DEP_RELDIR}
628.endif
629
630# on rare occasions, there can be a need for extra help
631_dep_hack := ${_this_dir}/${.MAKE.DEPENDFILE_PREFIX}.inc
632.-include <${_dep_hack}>
633.-include <${_dep_hack:R}.options>
634
635.if ${DEP_RELDIR} != ${_DEP_RELDIR} || ${DEP_TARGET_SPEC} != ${TARGET_SPEC}
636# this should be all
637_machines := ${DEP_MACHINE}
638.else
639# this is the machine list we actually use below
640_machines := ${_only_machines}
641
642.if defined(HOSTPROG) || ${DEP_MACHINE:Nhost*} == ""
643# we need to build this guy's dependencies for host as well.
644.if ${DEP_MACHINE:Nhost*} == ""
645_machines += ${DEP_MACHINE}
646.else
647_machines += host
648.endif
649.endif
650
651_machines := ${_machines:O:u}
652.endif
653
654.if ${TARGET_SPEC_VARS:[#]} > 1
655# we need to tweak _machines
656_dm := ${DEP_MACHINE}
657# apply the same filtering that we do when qualifying DIRDEPS.
658# M_dep_qual_fixes expects .${MACHINE}* so add (and remove) '.'
659# Again we expect that any already qualified machines are fully qualified.
660_machines := ${_machines:M*,*} ${_machines:N*,*:@DEP_MACHINE@${DEP_TARGET_SPEC}@:S,^,.,:S,^.,,}
661DEP_MACHINE := ${_dm}
662_machines := ${_machines:${M_dep_qual_fixes:ts:}:O:u}
663.endif
664
665# reset each time through
666_build_dirs =
667
668.if ${DEP_RELDIR} == ${_DEP_RELDIR} && ${_CURDIR} != ${SRCTOP}
669# pickup other machines for this dir if necessary
670_build_dirs += ${_machines:@m@${_CURDIR}.$m@}
671.endif
672
673.if ${_debug_reldir}
674.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: nDIRDEPS=${DIRDEPS:[#]}
675.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: DIRDEPS='${DIRDEPS}'
676.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: _machines='${_machines}'
677.endif
678
679.if !empty(DIRDEPS)
680# these we reset each time through as they can depend on DEP_MACHINE
681DEP_DIRDEPS_FILTER = \
682	${DIRDEPS_FILTER.${DEP_TARGET_SPEC}:U} \
683	${TARGET_SPEC_VARS:@v@${DIRDEPS_FILTER.${DEP_$v}:U}@} \
684	${DIRDEPS_FILTER:U}
685.if empty(DEP_DIRDEPS_FILTER)
686# something harmless
687DEP_DIRDEPS_FILTER = U
688.endif
689
690# this is what we start with
691__depdirs := ${DIRDEPS:${NSkipDir}:${DEP_DIRDEPS_FILTER:ts:}:C,//+,/,g:O:u:@d@${SRCTOP}/$d@}
692
693# some entries may be qualified with .<machine> or .<target_spec>
694# we can tell the unqualified ones easily - because they exist
695__unqual_depdirs := ${__depdirs:@d@${exists($d):?$d:}@}
696__qual_depdirs := ${__depdirs:${__unqual_depdirs:Uno:${M_ListToSkip}}}
697
698.if ${DEP_RELDIR} == ${_DEP_RELDIR}
699# if it was called out - we likely need it.
700__hostdpadd := ${DPADD:U.:M${HOST_OBJTOP}/*:S,${HOST_OBJTOP}/,,:H:${NSkipDir}:${DIRDEPS_FILTER:ts:}:S,$,.host,:N.*:@d@${SRCTOP}/$d@} \
701	${DPADD:U.:M${HOST_OBJTOP32:Uno}/*:S,${HOST_OBJTOP32:Uno}/,,:H:${NSkipDir}:${DIRDEPS_FILTER:ts:}:S,$,.host32,:N.*:@d@${SRCTOP}/$d@}
702__qual_depdirs += ${__hostdpadd}
703.endif
704
705.if ${_debug_reldir}
706.info DEP_DIRDEPS_FILTER=${DEP_DIRDEPS_FILTER:ts:}
707.info depdirs=${__depdirs:S,^${SRCTOP}/,,}
708.info qualified=${__qual_depdirs:S,^${SRCTOP}/,,}
709.info unqualified=${__unqual_depdirs:S,^${SRCTOP}/,,}
710.endif
711
712# _build_dirs is what we will feed to _DIRDEP_USE
713_build_dirs += \
714	${__qual_depdirs:M*.host:${NSkipHostDir}:N.host} \
715	${__qual_depdirs:N*.host} \
716	${_machines:Mhost*:@m@${__unqual_depdirs:@d@$d.$m@}@:${NSkipHostDir}:N.host} \
717	${_machines:Nhost*:@m@${__unqual_depdirs:@d@$d.$m@}@}
718
719# qualify everything now
720_build_dirs := ${_build_dirs:${M_dep_qual_fixes:ts:}:O:u}
721
722.endif				# empty DIRDEPS
723
724_build_all_dirs += ${_build_dirs} ${_build_xtra_dirs}
725_build_all_dirs := ${_build_all_dirs:O:u}
726
727# Normally if doing make -V something,
728# we do not want to waste time chasing DIRDEPS
729# but if we want to count the number of Makefile.depend* read, we do.
730.if ${.MAKEFLAGS:M-V${_V_READ_DIRDEPS:U}} == ""
731.if !empty(_build_all_dirs)
732.if ${BUILD_DIRDEPS_CACHE} == "yes"
733# we use _cache_script to minimize the number of times we fork the shell
734_cache_script = echo '\# ${DEP_RELDIR}.${DEP_TARGET_SPEC}';
735# guard against _new_dirdeps being too big for a single command line
736_new_dirdeps := ${_build_all_dirs:@x@${target($x):?:$x}@:S,^${SRCTOP}/,,}
737_cache_xtra_deps := ${_build_xtra_dirs:S,^${SRCTOP}/,,}
738.export _cache_xtra_deps _new_dirdeps
739.if !empty(DIRDEPS_EXPORT_VARS) || !empty(DEP_EXPORT_VARS)
740# Discouraged, but there are always exceptions.
741# Handle it here rather than explain how.
742DIRDEPS_EXPORT_VARS ?= ${DEP_EXPORT_VARS}
743_cache_xvars := echo; ${DIRDEPS_EXPORT_VARS:@v@echo '$v = ${$v}';@} echo '.export ${DIRDEPS_EXPORT_VARS}'; echo;
744_cache_script += ${_cache_xvars}
745.endif
746.else
747# this makes it all happen
748dirdeps: ${_build_all_dirs}
749.endif
750${_build_all_dirs}:	_DIRDEP_USE
751
752.if ${_debug_reldir}
753.info ${DEP_RELDIR}.${DEP_TARGET_SPEC}: needs: ${_build_dirs:S,^${SRCTOP}/,,}
754.endif
755
756.if !empty(DIRDEPS_EXPORT_VARS) || !empty(DEP_EXPORT_VARS)
757.export ${DIRDEPS_EXPORT_VARS} ${DEP_EXPORT_VARS}
758DIRDEPS_EXPORT_VARS =
759DEP_EXPORT_VARS =
760.endif
761
762# this builds the dependency graph
763.for m in ${_machines}
764.if ${BUILD_DIRDEPS_CACHE} == "yes" && !empty(_build_dirs)
765_cache_deps =
766_cache_script += echo; echo 'DIRDEPS.${_this_dir}.$m = \';
767.endif
768# it would be nice to do :N${.TARGET}
769.if !empty(__qual_depdirs)
770.for q in ${__qual_depdirs:${M_dep_qual_fixes:ts:}:E:O:u:N$m}
771.if ${_debug_reldir} || ${DEBUG_DIRDEPS:@x@${${DEP_RELDIR}.$m:L:M$x}${${DEP_RELDIR}.$q:L:M$x}@} != ""
772.info ${DEP_RELDIR}.$m: graph: ${_build_dirs:M*.$q:S,^${SRCTOP}/,,}
773.endif
774.if ${BUILD_DIRDEPS_CACHE} == "yes"
775_cache_deps += ${_build_dirs:M*.$q:S,^${SRCTOP}/,,}
776.else
777${_this_dir}.$m: ${_build_dirs:M*.$q}
778.endif
779.endfor
780.endif
781.if ${_debug_reldir}
782.info ${DEP_RELDIR}.$m: graph: ${_build_dirs:M*.$m:N${_this_dir}.$m:S,^${SRCTOP}/,,}
783.endif
784.if ${BUILD_DIRDEPS_CACHE} == "yes"
785.if !empty(_build_dirs)
786_cache_deps += ${_build_dirs:M*.$m:N${_this_dir}.$m:S,^${SRCTOP}/,,}
787.if !empty(_cache_deps)
788.export _cache_deps
789_cache_script += for x in $$_cache_deps; do echo "	_{SRCTOP}/$$x \\"; done;
790.endif
791# anything in _{build,env}_xtra_dirs is hooked to dirdeps: only
792x!= echo; { echo; ${_cache_script} echo; echo '${_this_dir}.$m: $${DIRDEPS.${_this_dir}.$m}'; \
793	echo; echo 'dirdeps: ${_this_dir}.$m \'; \
794	for x in $$_cache_xtra_deps; do echo "	_{SRCTOP}/$$x \\"; done; \
795	echo; for x in $$_new_dirdeps; do echo "_{SRCTOP}/$$x: _DIRDEP_USE"; done; } >&3
796.endif
797.else
798${_this_dir}.$m: ${_build_dirs:M*.$m:N${_this_dir}.$m}
799.endif
800.endfor
801
802.endif
803
804# Now find more dependencies - and recurse.
805.for d in ${_build_all_dirs}
806.if !target(_dirdeps_checked.$d)
807# once only
808_dirdeps_checked.$d:
809_dr := ${d:S,^${SRCTOP}/,,}
810.if ${_debug_search}
811.info checking ${_dr}
812.endif
813# Note: _build_all_dirs is fully qualifed so d:R is always the directory
814.if exists(${d:R})
815# we pass _DEP_TARGET_SPEC to tell the next step what we want
816_DEP_TARGET_SPEC := ${d:E}
817# some makefiles may still look at this
818_DEP_MACHINE := ${d:E:C/,.*//}
819# set these too in case Makefile.depend* uses them
820.if ${TARGET_SPEC_VARS:[#]} > 1
821_dtspec := ${_DEP_TARGET_SPEC:S/,/ /g}
822.for i in ${_tspec_x}
823DEP_${TARGET_SPEC_VARS:[$i]} := ${_dtspec:[$i]}
824.endfor
825.else
826DEP_MACHINE := ${_DEP_MACHINE}
827.endif
828# Warning: there is an assumption here that MACHINE is always
829# the first entry in TARGET_SPEC_VARS.
830# If TARGET_SPEC and MACHINE are insufficient, you have a problem.
831_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]}
832.if !empty(_m)
833# M_dep_qual_fixes isn't geared to Makefile.depend
834_qm := ${_m:C;(\.depend)$;\1.${d:E};:${M_dep_qual_fixes:ts:}}
835.if ${_debug_search}
836.info Looking for ${_qm}
837.endif
838# set this "just in case"
839# we can skip :tA since we computed the path above
840DEP_RELDIR := ${_m:H:S,^${SRCTOP}/,,}
841# and reset this
842DIRDEPS =
843.if ${_debug_reldir} && ${_qm} != ${_m}
844.info loading ${_m:S,${SRCTOP}/,,} for ${_dr}
845.endif
846.include <${_m}>
847.else
848# set these as if we found Makefile.depend*
849DEP_RELDIR := ${_dr:R}
850DIRDEPS =
851.if ${_debug_reldir}
852.info loading local.dirdeps-missing.mk for ${_dr}
853.endif
854.-include <local.dirdeps-missing.mk>
855.endif
856.endif
857.endif
858.endfor
859
860.endif				# -V
861.endif				# BUILD_DIRDEPS
862
863.elif ${.MAKE.LEVEL} > 42
864.error You should have stopped recursing by now.
865.else
866# we are building something
867DEP_RELDIR := ${RELDIR}
868_DEP_RELDIR := ${RELDIR}
869# Since we are/should be included by .MAKE.DEPENDFILE
870# This is a final opportunity to add/hook global rules.
871.-include <local.dirdeps-build.mk>
872
873# skip _reldir_{finish,failed} if not included from Makefile.depend*
874# or not in meta mode
875.if !defined(WITHOUT_META_STATS) && ${.INCLUDEDFROMFILE:U:M${.MAKE.DEPENDFILE_PREFIX}*} != "" && ${.MAKE.MODE:Mmeta} != ""
876
877meta_stats= meta=${empty(.MAKE.META.FILES):?0:${.MAKE.META.FILES:[#]}} \
878	created=${empty(.MAKE.META.CREATED):?0:${.MAKE.META.CREATED:[#]}}
879
880.if !target(_reldir_finish)
881.END: _reldir_finish
882_reldir_finish: .NOMETA
883	@echo "${TRACER}Finished ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
884.endif
885
886.if !target(_reldir_failed)
887.ERROR: _reldir_failed
888_reldir_failed: .NOMETA
889	@echo "${TRACER}Failed ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
890.endif
891
892.endif
893
894# pickup local dependencies
895.if ${MAKE_VERSION} < 20160220
896.-include <.depend>
897.else
898.dinclude <.depend>
899.endif
900.endif
901
902# bootstrapping new dependencies made easy?
903.if !target(bootstrap-empty)
904.if !target(bootstrap) && (make(bootstrap) || \
905	make(bootstrap-this) || \
906	make(bootstrap-recurse) || \
907	make(bootstrap-empty))
908
909# if we are bootstrapping create the default
910_want = ${.CURDIR}/${.MAKE.DEPENDFILE_DEFAULT:T}
911
912.if exists(${_want})
913# stop here
914${.TARGETS:Mboot*}:
915.elif !make(bootstrap-empty)
916# find a Makefile.depend to use as _src
917_src != cd ${.CURDIR} && for m in ${.MAKE.DEPENDFILE_PREFERENCE:T:S,${MACHINE},*,}; do test -s $$m || continue; echo $$m; break; done; echo
918.if empty(_src)
919.error cannot find any of ${.MAKE.DEPENDFILE_PREFERENCE:T}${.newline}Use: bootstrap-empty
920.endif
921
922_src?= ${.MAKE.DEPENDFILE}
923
924.MAKE.DEPENDFILE_BOOTSTRAP_SED+= -e 's/${_src:E:C/,.*//}/${MACHINE}/g'
925
926# just create Makefile.depend* for this dir
927bootstrap-this:	.NOTMAIN
928	@echo Bootstrapping ${RELDIR}/${_want:T} from ${_src:T}; \
929	echo You need to build ${RELDIR} to correctly populate it.
930.if ${_src:T} != ${.MAKE.DEPENDFILE_PREFIX:T}
931	(cd ${.CURDIR} && sed ${.MAKE.DEPENDFILE_BOOTSTRAP_SED} ${_src} > ${_want:T})
932.else
933	cp ${.CURDIR}/${_src:T} ${_want}
934.endif
935
936# create Makefile.depend* for this dir and its dependencies
937bootstrap: bootstrap-recurse
938bootstrap-recurse: bootstrap-this
939
940_mf := ${.PARSEFILE}
941bootstrap-recurse:	.NOTMAIN .MAKE
942	@cd ${SRCTOP} && \
943	for d in `cd ${RELDIR} && ${.MAKE} -B -f ${"${.MAKEFLAGS:M-n}":?${_src}:${.MAKE.DEPENDFILE:T}} -V DIRDEPS`; do \
944		test -d $$d || d=$${d%.*}; \
945		test -d $$d || continue; \
946		echo "Checking $$d for bootstrap ..."; \
947		(cd $$d && ${.MAKE} -f ${_mf} bootstrap-recurse); \
948	done
949
950.endif
951
952# create an empty Makefile.depend* to get the ball rolling.
953bootstrap-empty: .NOTMAIN .NOMETA
954	@echo Creating empty ${RELDIR}/${_want:T}; \
955	echo You need to build ${RELDIR} to correctly populate it.
956	@{ echo DIRDEPS=; echo ".include <dirdeps.mk>"; } > ${_want}
957
958.endif
959.endif
960