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