xref: /freebsd/contrib/bmake/mk/meta.autodep.mk (revision 6be3386466ab79a84b48429ae66244f21526d3df) 
1# $Id: meta.autodep.mk,v 1.53 2020/11/08 05:47:56 sjg Exp $
2
3#
4#	@(#) Copyright (c) 2010, Simon J. Gerraty
5#
6#	This file is provided in the hope that it will
7#	be of use.  There is absolutely NO WARRANTY.
8#	Permission to copy, redistribute or otherwise
9#	use this file is hereby granted provided that
10#	the above copyright notice and this notice are
11#	left intact.
12#
13#	Please send copies of changes and bug-fixes to:
14#	sjg@crufty.net
15#
16
17_this ?= ${.PARSEFILE}
18.if !target(__${_this}__)
19__${_this}__: .NOTMAIN
20
21.-include <local.autodep.mk>
22
23PICO?= .pico
24
25.if defined(SRCS)
26# it would be nice to be able to query .SUFFIXES
27OBJ_EXTENSIONS+= .o .po .lo ${PICO}
28
29# explicit dependencies help short-circuit .SUFFIX searches
30SRCS_DEP_FILTER+= N*.[hly]
31.for s in ${SRCS:${SRCS_DEP_FILTER:O:u:ts:}}
32.for e in ${OBJ_EXTENSIONS:O:u}
33.if !target(${s:T:R}$e)
34${s:T:R}$e: $s
35.endif
36.endfor
37.endfor
38.endif
39
40.if make(gendirdeps)
41# you are supposed to know what you are doing!
42UPDATE_DEPENDFILE = yes
43.elif !empty(.TARGETS) && !make(all)
44# do not update the *depend* files
45# unless we are building the entire directory or the default target.
46# NO means don't update .depend - or Makefile.depend*
47# no means update .depend but not Makefile.depend*
48UPDATE_DEPENDFILE = NO
49.elif ${.MAKEFLAGS:M-k} != ""
50# it is a bad idea to update anything
51UPDATE_DEPENDFILE = NO
52.endif
53
54_CURDIR ?= ${.CURDIR}
55_OBJDIR ?= ${.OBJDIR}
56_OBJTOP ?= ${OBJTOP}
57_OBJROOT ?= ${OBJROOT:U${_OBJTOP}}
58_DEPENDFILE := ${_CURDIR}/${.MAKE.DEPENDFILE:T}
59
60.if ${.MAKE.LEVEL} > 0
61# do not allow auto update if we ever built this dir without filemon
62NO_FILEMON_COOKIE = .nofilemon
63CLEANFILES += ${NO_FILEMON_COOKIE}
64.if ${.MAKE.MODE:Uno:Mnofilemon} != ""
65UPDATE_DEPENDFILE = NO
66all: ${NO_FILEMON_COOKIE}
67${NO_FILEMON_COOKIE}: .NOMETA
68	@echo UPDATE_DEPENDFILE=NO > ${.TARGET}
69.elif exists(${NO_FILEMON_COOKIE})
70UPDATE_DEPENDFILE = NO
71.warning ${RELDIR} built with nofilemon; UPDATE_DEPENDFILE=NO
72.endif
73.endif
74
75.if ${.MAKE.LEVEL} == 0
76UPDATE_DEPENDFILE = NO
77.endif
78.if !exists(${_DEPENDFILE})
79_bootstrap_dirdeps = yes
80.endif
81_bootstrap_dirdeps ?= no
82UPDATE_DEPENDFILE ?= yes
83
84.if ${DEBUG_AUTODEP:Uno:@m@${RELDIR:M$m}@} != ""
85.info ${_DEPENDFILE:S,${SRCTOP}/,,} update=${UPDATE_DEPENDFILE}
86.endif
87
88.if !empty(XMAKE_META_FILE)
89.if exists(${.OBJDIR}/${XMAKE_META_FILE})
90# we cannot get accurate dependencies from an update build
91UPDATE_DEPENDFILE = NO
92.else
93META_XTRAS += ${XMAKE_META_FILE}
94.endif
95.endif
96
97.if ${_bootstrap_dirdeps} == "yes" || exists(${_DEPENDFILE})
98# if it isn't supposed to be touched by us the Makefile should have
99# UPDATE_DEPENDFILE = no
100WANT_UPDATE_DEPENDFILE ?= yes
101.endif
102
103.if ${WANT_UPDATE_DEPENDFILE:Uno:tl} != "no"
104.if ${.MAKE.MODE:Uno:Mmeta*} == "" || ${.MAKE.MODE:Uno:M*read*} != ""
105UPDATE_DEPENDFILE = no
106.endif
107
108.if ${DEBUG_AUTODEP:Uno:@m@${RELDIR:M$m}@} != ""
109.info ${_DEPENDFILE:S,${SRCTOP}/,,} update=${UPDATE_DEPENDFILE}
110.endif
111
112.if ${UPDATE_DEPENDFILE:tl} == "yes"
113# sometimes we want .meta files generated to aid debugging/error detection
114# but do not want to consider them for dependencies
115# for example the result of running configure
116# just make sure this is not empty
117META_FILE_FILTER ?= N.meta
118# never consider these
119META_FILE_FILTER += Ndirdeps.cache*
120
121.if !empty(DPADD)
122# if we have any non-libs in DPADD,
123# they probably need to be paid attention to
124.if !empty(DPLIBS)
125FORCE_DPADD = ${DPADD:${DPLIBS:${M_ListToSkip}}:${DPADD_LAST:${M_ListToSkip}}}
126.else
127_nonlibs := ${DPADD:T:Nlib*:N*include}
128.if !empty(_nonlibs)
129FORCE_DPADD += ${_nonlibs:@x@${DPADD:M*/$x}@}
130.endif
131.endif
132.endif
133
134.if !make(gendirdeps)
135.END:	gendirdeps
136.endif
137
138# if we don't have OBJS, then .depend isn't useful
139.if !target(.depend) && (!empty(OBJS) || ${.ALLTARGETS:M*.o} != "")
140# some makefiles and/or targets contain
141# circular dependencies if you dig too deep
142# (as meta mode is apt to do)
143# so we provide a means of suppressing them.
144# the input to the loop below is target: dependency
145# with just one dependency per line.
146# Also some targets are not really local, or use random names.
147# Use local.autodep.mk to provide local additions!
148SUPPRESS_DEPEND += \
149	${SB:S,/,_,g}* \
150	*:y.tab.c \
151	*.c:*.c \
152	*.h:*.h
153
154.NOPATH:	.depend
155# we use ${.MAKE.META.CREATED} to trigger an update but
156# we process using ${.MAKE.META.FILES}
157# the double $$ defers initial evaluation
158# if necessary, we fake .po dependencies, just so the result
159# in Makefile.depend* is stable
160# The current objdir may be referred to in various ways
161OBJDIR_REFS += ${.OBJDIR} ${.OBJDIR:tA} ${_OBJDIR} ${RELOBJTOP}/${RELDIR}
162_depend = .depend
163# it would be nice to be able to get .SUFFIXES as ${.SUFFIXES}
164# we actually only care about the .SUFFIXES of files that might be
165# generated by tools like yacc.
166DEPEND_SUFFIXES += .c .h .cpp .hpp .cxx .hxx .cc .hh
167.depend: .NOMETA $${.MAKE.META.CREATED} ${_this}
168	@echo "Updating $@: ${.OODATE:T:[1..8]}"
169	@egrep -i '^R .*\.(${DEPEND_SUFFIXES:tl:O:u:S,^.,,:ts|})$$' /dev/null ${.MAKE.META.FILES:T:O:u:${META_FILE_FILTER:ts:}:M*o.meta} | \
170	sed -e 's, \./, ,${OBJDIR_REFS:O:u:@d@;s, $d/, ,@};/\//d' \
171		-e 's,^\([^/][^/]*\).meta...[0-9]* ,\1: ,' | \
172	sort -u | \
173	while read t d; do \
174		case "$$d:" in $$t) continue;; esac; \
175		case "$$t$$d" in ${SUPPRESS_DEPEND:U.:O:u:ts|}) continue;; esac; \
176		echo $$t $$d; \
177	done > $@.${.MAKE.PID}
178	@case "${.MAKE.META.FILES:T:M*.po.*}" in \
179	*.po.*) mv $@.${.MAKE.PID} $@;; \
180	*) { cat $@.${.MAKE.PID}; \
181	sed ${OBJ_EXTENSIONS:N.o:N.po:@o@-e 's,\$o:,.o:,'@} \
182		-e 's,\.o:,.po:,' $@.${.MAKE.PID}; } | sort -u > $@; \
183	rm -f $@.${.MAKE.PID};; \
184	esac
185.else
186# make sure this exists
187.depend:
188# do _not_ assume that .depend is in any fit state for us to use
189CAT_DEPEND = /dev/null
190.if ${.MAKE.LEVEL} > 0
191.export CAT_DEPEND
192.endif
193_depend =
194.endif
195
196.if ${DEBUG_AUTODEP:Uno:@m@${RELDIR:M$m}@} != ""
197.info ${_DEPENDFILE:S,${SRCTOP}/,,} _depend=${_depend}
198.endif
199
200.if ${UPDATE_DEPENDFILE} == "yes"
201gendirdeps:	${_DEPENDFILE}
202.endif
203
204.if !target(${_DEPENDFILE})
205.if ${_bootstrap_dirdeps} == "yes"
206# We are boot-strapping a new directory
207# Use DPADD to seed DIRDEPS
208.if !empty(DPADD)
209# anything which matches ${_OBJROOT}* but not ${_OBJTOP}*
210# needs to be qualified in DIRDEPS
211# The pseudo machine "host" is used for HOST_TARGET
212DIRDEPS += \
213	${DPADD:M${_OBJTOP}*:H:C,${_OBJTOP}[^/]*/,,:N.:O:u} \
214	${DPADD:M${_OBJROOT}*:N${_OBJTOP}*:N${STAGE_ROOT:U${_OBJTOP}}/*:H:S,${_OBJROOT},,:C,^([^/]+)/(.*),\2.\1,:S,${HOST_TARGET}$,host,:N.*:O:u}
215
216.endif
217.endif
218
219_gendirdeps_mutex =
220.if defined(NEED_GENDIRDEPS_MUTEX)
221# If a src dir gets built with multiple object dirs,
222# we need a mutex.  Obviously, this is best avoided.
223# Note if .MAKE.DEPENDFILE is common for all ${MACHINE}
224# you either need to mutex, or ensure only one machine builds at a time!
225# lockf is an example of a suitable tool
226LOCKF ?= /usr/bin/lockf
227.if exists(${LOCKF})
228GENDIRDEPS_MUTEXER ?= ${LOCKF} -k
229.endif
230.if empty(GENDIRDEPS_MUTEXER)
231.error NEED_GENDIRDEPS_MUTEX defined, but GENDIRDEPS_MUTEXER not set
232.else
233_gendirdeps_mutex = ${GENDIRDEPS_MUTEXER} ${GENDIRDEPS_MUTEX:U${_CURDIR}/Makefile}
234.endif
235.endif
236
237# If we have META_XTRAS we most likely did not create them
238# but we need to behave as if we did.
239# Avoid adding glob patterns to .MAKE.META.CREATED though.
240.MAKE.META.CREATED += ${META_XTRAS:N*\**:O:u}
241
242.if make(gendirdeps)
243META_FILES = *.meta
244.elif ${OPTIMIZE_OBJECT_META_FILES:Uno:tl} == "no"
245META_FILES = ${.MAKE.META.FILES:T:N.depend*:O:u}
246.else
247# if we have 1000's of .o.meta, ${PICO}.meta etc we need only look at one set
248# it is left as an exercise for the reader to work out what this does
249META_FILES = ${.MAKE.META.FILES:T:N.depend*:N*o.meta:O:u} \
250	${.MAKE.META.FILES:T:M*.${.MAKE.META.FILES:M*o.meta:R:E:O:u:[1]}.meta:O:u}
251.endif
252
253.if ${DEBUG_AUTODEP:Uno:@m@${RELDIR:M$m}@} != ""
254.info ${_DEPENDFILE:S,${SRCTOP}/,,}: ${_depend} ${.PARSEDIR}/gendirdeps.mk ${META2DEPS} xtras=${META_XTRAS}
255.endif
256
257.if ${.MAKE.LEVEL} > 0
258.if ${UPDATE_DEPENDFILE} == "yes"
259.-include <${.CURDIR}/${.MAKE.DEPENDFILE_PREFIX}.options>
260.endif
261.if !empty(GENDIRDEPS_FILTER)
262.export GENDIRDEPS_FILTER
263.endif
264# export to avoid blowing command line limit
265META_FILES := ${META_XTRAS:U:O:u} ${META_FILES:U:T:O:u:${META_FILE_FILTER:ts:}}
266.export META_FILES
267.endif
268
269# we might have .../ in MAKESYSPATH
270_makesyspath:= ${_PARSEDIR}
271${_DEPENDFILE}: ${_depend} ${.PARSEDIR}/gendirdeps.mk  ${META2DEPS} $${.MAKE.META.CREATED}
272	@echo Checking $@: ${.OODATE:T:[1..8]}
273	@(cd . && ${GENDIRDEPS_ENV} \
274	SKIP_GENDIRDEPS='${SKIP_GENDIRDEPS:O:u}' \
275	DPADD='${FORCE_DPADD:O:u}' ${_gendirdeps_mutex} \
276	MAKESYSPATH=${_makesyspath} \
277	${.MAKE} -f gendirdeps.mk RELDIR=${RELDIR} _DEPENDFILE=${_DEPENDFILE})
278	@test -s $@ && touch $@; :
279.endif
280
281.endif
282.endif
283
284.if ${_bootstrap_dirdeps} == "yes"
285DIRDEPS+= ${RELDIR}.${TARGET_SPEC:U${MACHINE}}
286# make sure this is included at least once
287.include <dirdeps.mk>
288.else
289${_DEPENDFILE}: .PRECIOUS
290.endif
291
292CLEANFILES += *.meta filemon.* *.db
293
294# these make it easy to gather some stats
295now_utc = ${%s:L:gmtime}
296start_utc := ${now_utc}
297
298meta_stats= meta=${empty(.MAKE.META.FILES):?0:${.MAKE.META.FILES:[#]}} \
299	created=${empty(.MAKE.META.CREATED):?0:${.MAKE.META.CREATED:[#]}}
300
301#.END: _reldir_finish
302.if target(gendirdeps)
303_reldir_finish: gendirdeps
304.endif
305_reldir_finish: .NOMETA
306	@echo "${TIME_STAMP} Finished ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
307
308#.ERROR: _reldir_failed
309_reldir_failed: .NOMETA
310	@echo "${TIME_STAMP} Failed ${RELDIR}.${TARGET_SPEC} seconds=$$(( ${now_utc} - ${start_utc} )) ${meta_stats}"
311
312.if !defined(WITHOUT_META_STATS) && ${.MAKE.LEVEL} > 0
313.END: _reldir_finish
314.ERROR: _reldir_failed
315.endif
316
317.endif
318