xref: /freebsd/share/mk/gendirdeps.mk (revision d6eb98610fa65663bf0df4574b7cb2c5c4ffda71)
1# $FreeBSD$
2# $Id: gendirdeps.mk,v 1.39 2018/06/08 01:25:31 sjg Exp $
3
4# Copyright (c) 2010-2013, 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#
29# This makefile [re]generates ${.MAKE.DEPENDFILE}
30#
31
32.include <install-new.mk>
33
34# Assumptions:
35#	RELDIR is the relative path from ${SRCTOP} to ${_CURDIR}
36#		(SRCTOP is ${SB}/src)
37#	_CURDIR is the absolute version of ${.CURDIR}
38#	_OBJDIR is the absolute version of ${.OBJDIR}
39#	_objroot is realpath of ${_OBJTOP} without ${MACHINE}
40#		this may be different from _OBJROOT if $SB/obj is a
41#		symlink to another filesystem.
42#		_objroot must be a prefix match for _objtop
43
44.MAIN: all
45
46# keep this simple
47.MAKE.MODE = compat
48
49all:
50
51_CURDIR ?= ${.CURDIR}
52_OBJDIR ?= ${.OBJDIR}
53_OBJTOP ?= ${OBJTOP}
54_OBJROOT ?= ${OBJROOT:U${_OBJTOP}}
55.if ${_OBJROOT:M*/}
56_slash=/
57.else
58_slash=
59.endif
60_objroot ?= ${_OBJROOT:tA}${_slash}
61
62_this = ${.PARSEDIR}/${.PARSEFILE}
63
64# remember what to make
65_DEPENDFILE := ${_CURDIR}/${.MAKE.DEPENDFILE:T}
66
67# We do _not_ want to read our own output!
68.MAKE.DEPENDFILE = /dev/null
69
70# caller should have set this
71META_FILES ?= ${.MAKE.META.FILES}
72
73.if !empty(META_FILES)
74
75.if ${.MAKE.LEVEL} > 0 && !empty(GENDIRDEPS_FILTER)
76# so we can compare below
77.-include <${_DEPENDFILE}>
78# yes, I mean :U with no value
79_DIRDEPS := ${DIRDEPS:U:O:u}
80.endif
81
82META_FILES := ${META_FILES:T:O:u}
83.export META_FILES
84
85# pickup customizations
86.-include <local.gendirdeps.mk>
87
88# these are actually prefixes that we'll skip
89# they should all be absolute paths
90SKIP_GENDIRDEPS ?=
91.if !empty(SKIP_GENDIRDEPS)
92_skip_gendirdeps = egrep -v '^(${SKIP_GENDIRDEPS:O:u:ts|})' |
93.else
94_skip_gendirdeps =
95.endif
96
97# Below we will turn _{VAR} into ${VAR} which keeps this simple
98# GENDIRDEPS_FILTER_DIR_VARS is a list of dirs to be substiuted for.
99# GENDIRDEPS_FILTER_VARS is more general.
100# In each case order matters.
101.if !empty(GENDIRDEPS_FILTER_DIR_VARS)
102GENDIRDEPS_FILTER += ${GENDIRDEPS_FILTER_DIR_VARS:@v@S,${$v},_{${v}},@}
103.endif
104.if !empty(GENDIRDEPS_FILTER_VARS)
105GENDIRDEPS_FILTER += ${GENDIRDEPS_FILTER_VARS:@v@S,/${$v}/,/_{${v}}/,@:NS,//,*:u}
106.endif
107
108# this (*should* be set in meta.sys.mk)
109# is the script that extracts what we want.
110META2DEPS ?= ${.PARSEDIR}/meta2deps.sh
111META2DEPS := ${META2DEPS}
112
113.if ${DEBUG_GENDIRDEPS:Uno:@x@${RELDIR:M$x}@} != "" && ${DEBUG_GENDIRDEPS:Uno:Mmeta2d*} != ""
114_time = time
115_sh_x = sh -x
116_py_d = -ddd
117.else
118_time =
119_sh_x =
120_py_d =
121.endif
122
123.if ${META2DEPS:E} == "py"
124# we can afford to do this all the time.
125DPDEPS ?= no
126META2DEPS_CMD = ${_time} ${PYTHON} ${META2DEPS} ${_py_d}
127.if ${DPDEPS:tl} != "no"
128META2DEPS_CMD += -D ${DPDEPS}
129.endif
130META2DEPS_FILTER = sed 's,^src:,${SRCTOP}/,;s,^\([^/]\),${OBJTOP}/\1,' |
131.elif ${META2DEPS:E} == "sh"
132META2DEPS_CMD = ${_time} ${_sh_x} ${META2DEPS} OBJTOP=${_OBJTOP}
133.else
134META2DEPS_CMD ?= ${META2DEPS}
135.endif
136
137.if ${TARGET_OBJ_SPEC:U${MACHINE}} != ${MACHINE}
138META2DEPS_CMD += -T ${TARGET_OBJ_SPEC}
139.endif
140META2DEPS_CMD += \
141	-R ${RELDIR} -H ${HOST_TARGET} \
142	${M2D_OBJROOTS:O:u:@o@-O $o@} \
143	${M2D_EXCLUDES:O:u:@o@-X $o@} \
144
145
146M2D_OBJROOTS += ${OBJTOP} ${_OBJROOT} ${_objroot}
147.if defined(SB_OBJROOT)
148M2D_OBJROOTS += ${SB_OBJROOT}
149.endif
150.if defined(STAGE_ROOT)
151M2D_OBJROOTS += ${STAGE_ROOT}
152.endif
153.if ${.MAKE.DEPENDFILE_PREFERENCE:U${.MAKE.DEPENDFILE}:M*.${MACHINE}} == ""
154# meta2deps.py only groks objroot
155# so we need to give it what it expects
156# and tell it not to add machine qualifiers
157META2DEPS_ARGS += MACHINE=none
158.endif
159.if defined(SB_BACKING_SB)
160META2DEPS_CMD += -S ${SB_BACKING_SB}/src
161M2D_OBJROOTS += ${SB_BACKING_SB}/${SB_OBJPREFIX}
162.endif
163
164GENDIRDEPS_SEDCMDS += \
165	-e 's,//*$$,,;s,\.${HOST_TARGET:Uhost}$$,.host,' \
166	-e 's,\.${HOST_TARGET32:Uhost32}$$,.host32,' \
167	-e 's,\.${MACHINE}$$,,' \
168	-e 's:\.${TARGET_SPEC:U${MACHINE}}$$::'
169
170# we are only interested in the dirs
171# specifically those we read something from.
172# we canonicalize them to keep things simple
173# if we are using a split-fs sandbox, it gets a little messier.
174_objtop := ${_OBJTOP:tA}
175
176# some people put *.meta in META_XTRAS to make sure we get here
177_meta_files := ${META_FILES:N\*.meta:O:u}
178# assume a big list
179_meta_files_arg= @meta.list
180.if empty(_meta_files) && ${META_FILES:M\*.meta} != ""
181# XXX this should be considered a bad idea,
182# since we cannot ignore stale .meta
183x != cd ${_OBJDIR} && find . -name '*.meta' -print -o \( -type d ! -name . -prune \) | sed 's,^./,,' > meta.list; echo
184.elif ${_meta_files:[#]} > 500
185.export _meta_files
186x != echo; for m in $$_meta_files; do echo $$m; done > meta.list
187.else
188_meta_files_arg:= ${_meta_files}
189.endif
190
191dir_list != cd ${_OBJDIR} && \
192	${META2DEPS_CMD} MACHINE=${MACHINE} \
193	SRCTOP=${SRCTOP} RELDIR=${RELDIR} CURDIR=${_CURDIR} \
194	${META2DEPS_ARGS} \
195	${_meta_files_arg} | ${META2DEPS_FILTER} ${_skip_gendirdeps} \
196	sed ${GENDIRDEPS_SEDCMDS}
197
198.if ${dir_list:M*ERROR\:*} != ""
199.warning ${dir_list:tW:C,.*(ERROR),\1,}
200.warning Skipping ${_DEPENDFILE:S,${SRCTOP}/,,}
201# we are not going to update anything
202.else
203dpadd_dir_list=
204.if !empty(DPADD)
205_nonlibs := ${DPADD:T:Nlib*:N*include}
206.if !empty(_nonlibs)
207ddep_list =
208.for f in ${_nonlibs:@x@${DPADD:M*/$x}@}
209.if exists($f.dirdep)
210ddep_list += $f.dirdep
211.elif exists(${f:H}.dirdep)
212ddep_list += ${f:H}.dirdep
213.else
214dir_list += ${f:H:tA}
215dpadd_dir_list += ${f:H:tA}
216.endif
217.endfor
218.if !empty(ddep_list)
219ddeps != cat ${ddep_list:O:u} | ${META2DEPS_FILTER} ${_skip_gendirdeps} \
220	sed ${GENDIRDEPS_SEDCMDS}
221
222.if ${DEBUG_GENDIRDEPS:Uno:@x@${RELDIR:M$x}@} != ""
223.info ${RELDIR}: raw_dir_list='${dir_list}'
224.info ${RELDIR}: ddeps='${ddeps}'
225.endif
226dir_list += ${ddeps}
227.endif
228.endif
229.endif
230
231# DIRDEPS represent things that had to have been built first
232# so they should all be undir OBJTOP.
233# Note that ${_OBJTOP}/bsd/include/machine will get reported
234# to us as $SRCTOP/bsd/sys/$MACHINE_ARCH/include meaning we
235# will want to visit bsd/include
236# so we add
237# ${"${dir_list:M*bsd/sys/${MACHINE_ARCH}/include}":?bsd/include:}
238# to GENDIRDEPS_DIR_LIST_XTRAS
239_objtops = ${OBJTOP} ${_OBJTOP} ${_objtop}
240_objtops := ${_objtops:O:u}
241dirdep_list = \
242	${_objtops:@o@${dir_list:M$o*/*:C,$o[^/]*/,,}@} \
243	${GENDIRDEPS_DIR_LIST_XTRAS}
244
245# sort longest first
246M2D_OBJROOTS := ${M2D_OBJROOTS:O:u:[-1..1]}
247
248# anything we use from an object dir other than ours
249# needs to be qualified with its .<machine> suffix
250# (we used the pseudo machine "host" for the HOST_TARGET).
251skip_ql= ${SRCTOP}* ${_objtops:@o@$o*@}
252.for o in ${M2D_OBJROOTS:${skip_ql:${M_ListToSkip}}}
253# we need := so only skip_ql to this point applies
254ql.$o := ${dir_list:${skip_ql:${M_ListToSkip}}:M$o*/*/*:C,$o([^/]+)/(.*),\2.\1,:S,.${HOST_TARGET},.host,}
255qualdir_list += ${ql.$o}
256.if ${DEBUG_GENDIRDEPS:Uno:@x@${RELDIR:M$x}@} != ""
257.info ${RELDIR}: o=$o ${ql.$o qualdir_list:L:@v@$v=${$v}@}
258.endif
259skip_ql+= $o*
260.endfor
261
262dirdep_list := ${dirdep_list:O:u}
263qualdir_list := ${qualdir_list:N*.${MACHINE}:O:u}
264
265DIRDEPS = \
266	${dirdep_list:N${RELDIR}:N${RELDIR}/*} \
267	${qualdir_list:N${RELDIR}.*:N${RELDIR}/*}
268
269# We only consider things below $RELDIR/ if they have a makefile.
270# This is the same test that _DIRDEP_USE applies.
271# We have do a double test with dirdep_list as it _may_ contain
272# qualified dirs - if we got anything from a stage dir.
273# qualdir_list we know are all qualified.
274# It would be nice do peform this check for all of DIRDEPS,
275# but we cannot assume that all of the tree is present,
276# in fact we can only assume that RELDIR is.
277DIRDEPS += \
278	${dirdep_list:M${RELDIR}/*:@d@${.MAKE.MAKEFILE_PREFERENCE:@m@${exists(${SRCTOP}/$d/$m):?$d:${exists(${SRCTOP}/${d:R}/$m):?$d:}}@}@} \
279	${qualdir_list:M${RELDIR}/*:@d@${.MAKE.MAKEFILE_PREFERENCE:@m@${exists(${SRCTOP}/${d:R}/$m):?$d:}@}@}
280
281# what modifiers do we allow in GENDIRDEPS_FILTER
282GENDIRDEPS_FILTER_MASK += @CMNS
283DIRDEPS := ${DIRDEPS:${GENDIRDEPS_FILTER:UNno:M[${GENDIRDEPS_FILTER_MASK:O:u:ts}]*:ts:}:C,//+,/,g:O:u}
284
285.if ${DEBUG_GENDIRDEPS:Uno:@x@${RELDIR:M$x}@} != ""
286.info ${RELDIR}: M2D_OBJROOTS=${M2D_OBJROOTS}
287.info ${RELDIR}: M2D_EXCLUDES=${M2D_EXCLUDES}
288.info ${RELDIR}: dir_list='${dir_list}'
289.info ${RELDIR}: dpadd_dir_list='${dpadd_dir_list}'
290.info ${RELDIR}: dirdep_list='${dirdep_list}'
291.info ${RELDIR}: qualdir_list='${qualdir_list}'
292.info ${RELDIR}: SKIP_GENDIRDEPS='${SKIP_GENDIRDEPS}'
293.info ${RELDIR}: GENDIRDEPS_FILTER='${GENDIRDEPS_FILTER}'
294.info ${RELDIR}: FORCE_DPADD='${DPADD}'
295.info ${RELDIR}: DIRDEPS='${DIRDEPS}'
296.endif
297
298# SRC_DIRDEPS is for checkout logic
299src_dirdep_list = \
300	${dir_list:M${SRCTOP}/*:S,${SRCTOP}/,,}
301
302SRC_DIRDEPS = \
303	${src_dirdep_list:N${RELDIR}:N${RELDIR}/*:C,(/h)/.*,,}
304
305SRC_DIRDEPS := ${SRC_DIRDEPS:${GENDIRDEPS_SRC_FILTER:UN/*:ts:}:C,//+,/,g:O:u}
306
307# if you want to capture SRC_DIRDEPS in .MAKE.DEPENDFILE put
308# SRC_DIRDEPS_FILE = ${_DEPENDFILE}
309# in local.gendirdeps.mk
310.if ${SRC_DIRDEPS_FILE:Uno:tl} != "no"
311ECHO_SRC_DIRDEPS = echo 'SRC_DIRDEPS = \'; echo '${SRC_DIRDEPS:@d@	$d \\${.newline}@}'; echo;
312
313.if ${SRC_DIRDEPS_FILE:T} == ${_DEPENDFILE:T}
314_include_src_dirdeps = ${ECHO_SRC_DIRDEPS}
315.else
316all: ${SRC_DIRDEPS_FILE}
317.if !target(${SRC_DIRDEPS_FILE})
318${SRC_DIRDEPS_FILE}: ${META_FILES} ${_this} ${META2DEPS}
319	@(${ECHO_SRC_DIRDEPS}) > $@
320.endif
321.endif
322.endif
323_include_src_dirdeps ?=
324
325all:	${_DEPENDFILE}
326
327# if this is going to exist it would be there by now
328.if !exists(.depend)
329CAT_DEPEND = /dev/null
330.endif
331CAT_DEPEND ?= .depend
332
333.if !empty(_DIRDEPS) && ${DIRDEPS} != ${_DIRDEPS}
334# we may have changed a filter
335.PHONY: ${_DEPENDFILE}
336.endif
337
338# 'cat .depend' should suffice, but if we are mixing build modes
339# .depend may contain things we don't want.
340# The sed command at the end of the stream, allows for the filters
341# to output _{VAR} tokens which we will turn into proper ${VAR} references.
342${_DEPENDFILE}: .NOMETA ${CAT_DEPEND:M.depend} ${META_FILES:O:u:@m@${exists($m):?$m:}@} ${_this} ${META2DEPS}
343	@(${GENDIRDEPS_HEADER} echo '# Autogenerated - do NOT edit!'; echo; \
344	echo 'DIRDEPS = \'; \
345	echo '${DIRDEPS:@d@	$d \\${.newline}@}'; echo; \
346	${_include_src_dirdeps} \
347	echo '.include <dirdeps.mk>'; \
348	echo; \
349	echo '.if $${DEP_RELDIR} == $${_DEP_RELDIR}'; \
350	echo '# local dependencies - needed for -jN in clean tree'; \
351	[ -s ${CAT_DEPEND} ] && { grep : ${CAT_DEPEND} | grep -v '[/\\]'; }; \
352	echo '.endif' ) | sed 's,_\([{(]\),$$\1,g' > $@.new${.MAKE.PID}
353	@${InstallNew}; InstallNew -s $@.new${.MAKE.PID}
354
355.endif				# meta2deps failed
356.elif !empty(SUBDIR)
357
358DIRDEPS := ${SUBDIR:S,^,${RELDIR}/,:O:u}
359
360all:	${_DEPENDFILE}
361
362${_DEPENDFILE}: .NOMETA ${MAKEFILE} ${_this}
363	@(${GENDIRDEPS_HEADER} echo '# Autogenerated - do NOT edit!'; echo; \
364	echo 'DIRDEPS = \'; \
365	echo '${DIRDEPS:@d@	$d \\${.newline}@}'; echo; \
366	echo '.include <dirdeps.mk>'; \
367	echo ) | sed 's,_\([{(]\),$$\1,g' > $@.new
368	@${InstallNew}; InstallNew $@.new
369
370.else
371
372# nothing to do
373all ${_DEPENDFILE}:
374
375.endif
376${_DEPENDFILE}: .PRECIOUS
377