xref: /freebsd/share/mk/meta.stage.mk (revision 907b59d76938e654f0d040a888e8dfca3de1e222)
1# $FreeBSD$
2# $Id: meta.stage.mk,v 1.45 2016/05/26 03:59:09 sjg Exp $
3#
4#	@(#) Copyright (c) 2011, 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.if !target(__${.PARSEFILE}__)
18__${.PARSEFILE}__:
19
20.if ${.MAKE.DEPENDFILE_PREFERENCE:U${.MAKE.DEPENDFILE}:M*.${MACHINE}} != ""
21# this is generally safer anyway
22_dirdep = ${RELDIR}.${MACHINE}
23.else
24_dirdep = ${RELDIR}
25.endif
26
27CLEANFILES+= .dirdep
28
29# this allows us to trace dependencies back to their src dir
30.dirdep:	.NOPATH
31	@echo '${_dirdep}' > $@
32
33.if defined(NO_POSIX_SHELL) || ${type printf:L:sh:Mbuiltin} == ""
34_stage_file_basename = `basename $$f`
35_stage_target_dirname = `dirname $$t`
36.else
37_stage_file_basename = $${f\#\#*/}
38_stage_target_dirname = $${t%/*}
39.endif
40
41_OBJROOT ?= ${OBJROOT:U${OBJTOP:H}}
42.if ${_OBJROOT:M*/} != ""
43_objroot ?= ${_OBJROOT:tA}/
44.else
45_objroot ?= ${_OBJROOT:tA}
46.endif
47
48# make sure this is global
49_STAGED_DIRS ?=
50.export _STAGED_DIRS
51# add each dir we stage to to _STAGED_DIRS
52# and make sure we have absolute paths so that bmake
53# will match against .MAKE.META.BAILIWICK
54STAGE_DIR_FILTER = tA:@d@$${_STAGED_DIRS::+=$$d}$$d@
55# convert _STAGED_DIRS into suitable filters
56GENDIRDEPS_FILTER += Nnot-empty-is-important \
57	${_STAGED_DIRS:O:u:M${OBJTOP}*:S,${OBJTOP}/,N,} \
58	${_STAGED_DIRS:O:u:M${_objroot}*:N${OBJTOP}*:S,${_objroot},,:C,^([^/]+)/(.*),N\2.\1,:S,${HOST_TARGET},.host,}
59
60LN_CP_SCRIPT = LnCp() { \
61  rm -f $$2 2> /dev/null; \
62  { [ -z "$$mode" ] && ln $$1 $$2 2> /dev/null; } || \
63  cp -p $$1 $$2; }
64
65# a staging conflict should cause an error
66# a warning is handy when bootstapping different options.
67STAGE_CONFLICT?= ERROR
68.if ${STAGE_CONFLICT:tl} == "error"
69STAGE_CONFLICT_ACTION= exit 1;
70.else
71STAGE_CONFLICT_ACTION=
72.endif
73
74# it is an error for more than one src dir to try and stage
75# the same file
76STAGE_DIRDEP_SCRIPT = ${LN_CP_SCRIPT}; StageDirdep() { \
77  t=$$1; \
78  if [ -s $$t.dirdep ]; then \
79	cmp -s .dirdep $$t.dirdep && return; \
80	echo "${STAGE_CONFLICT}: $$t installed by `cat $$t.dirdep` not ${_dirdep}" >&2; \
81	${STAGE_CONFLICT_ACTION} \
82  fi; \
83  LnCp .dirdep $$t.dirdep || exit 1; }
84
85# common logic for staging files
86# this all relies on RELDIR being set to a subdir of SRCTOP
87# we use ln(1) if we can, else cp(1)
88STAGE_FILE_SCRIPT = ${STAGE_DIRDEP_SCRIPT}; StageFiles() { \
89  case "$$1" in "") return;; -m) mode=$$2; shift 2;; *) mode=;; esac; \
90  dest=$$1; shift; \
91  mkdir -p $$dest; \
92  [ -s .dirdep ] || echo '${_dirdep}' > .dirdep; \
93  for f in "$$@"; do \
94	case "$$f" in */*) t=$$dest/${_stage_file_basename};; *) t=$$dest/$$f;; esac; \
95	StageDirdep $$t; \
96	LnCp $$f $$t || exit 1; \
97	[ -z "$$mode" ] || chmod $$mode $$t; \
98  done; :; }
99
100STAGE_LINKS_SCRIPT = ${STAGE_DIRDEP_SCRIPT}; StageLinks() { \
101  case "$$1" in "") return;; --) shift;; -*) ldest= lnf=$$1; shift;; /*) ldest=$$1/;; esac; \
102  dest=$$1; shift; \
103  mkdir -p $$dest; \
104  [ -s .dirdep ] || echo '${_dirdep}' > .dirdep; \
105  while test $$\# -ge 2; do \
106	l=$$ldest$$1; shift; \
107	t=$$dest/$$1; \
108	case "$$1" in */*) mkdir -p ${_stage_target_dirname};; esac; \
109	shift; \
110	StageDirdep $$t; \
111	rm -f $$t 2>/dev/null; \
112	ln $$lnf $$l $$t || exit 1; \
113  done; :; }
114
115STAGE_AS_SCRIPT = ${STAGE_DIRDEP_SCRIPT}; StageAs() { \
116  case "$$1" in "") return;; -m) mode=$$2; shift 2;; *) mode=;; esac; \
117  dest=$$1; shift; \
118  mkdir -p $$dest; \
119  [ -s .dirdep ] || echo '${_dirdep}' > .dirdep; \
120  while test $$\# -ge 2; do \
121	s=$$1; shift; \
122	t=$$dest/$$1; \
123	case "$$1" in */*) mkdir -p ${_stage_target_dirname};; esac; \
124	shift; \
125	StageDirdep $$t; \
126	LnCp $$s $$t || exit 1; \
127	[ -z "$$mode" ] || chmod $$mode $$t; \
128  done; :; }
129
130# this is simple, a list of the "staged" files depends on this,
131_STAGE_BASENAME_USE:	.USE ${.TARGET:T}
132	@${STAGE_FILE_SCRIPT}; StageFiles ${.TARGET:H:${STAGE_DIR_FILTER}} ${.TARGET:T}
133
134_STAGE_AS_BASENAME_USE:        .USE ${.TARGET:T}
135	@${STAGE_AS_SCRIPT}; StageAs ${.TARGET:H:${STAGE_DIR_FILTER}} ${.TARGET:T} ${STAGE_AS_${.TARGET:T}:U${.TARGET:T}}
136
137.if !empty(STAGE_INCSDIR)
138STAGE_TARGETS += stage_incs
139STAGE_INCS ?= ${.ALLSRC:N.dirdep:Nstage_*}
140
141stage_includes: stage_incs
142stage_incs:	.dirdep
143	@${STAGE_FILE_SCRIPT}; StageFiles ${STAGE_INCSDIR:${STAGE_DIR_FILTER}} ${STAGE_INCS}
144	@touch $@
145.endif
146
147.if !empty(STAGE_LIBDIR)
148STAGE_TARGETS += stage_libs
149
150STAGE_LIBS ?= ${.ALLSRC:N.dirdep:Nstage_*}
151
152stage_libs:	.dirdep
153	@${STAGE_FILE_SCRIPT}; StageFiles ${STAGE_LIBDIR:${STAGE_DIR_FILTER}} ${STAGE_LIBS}
154.if !defined(NO_SHLIB_LINKS)
155.if !empty(SHLIB_LINKS)
156	@${STAGE_LINKS_SCRIPT}; StageLinks -s ${STAGE_LIBDIR:${STAGE_DIR_FILTER}} \
157	${SHLIB_LINKS:@t@${STAGE_LIBS:T:M$t.*} $t@}
158.elif !empty(SHLIB_LINK) && !empty(SHLIB_NAME)
159	@${STAGE_LINKS_SCRIPT}; StageLinks -s ${STAGE_LIBDIR:${STAGE_DIR_FILTER}} ${SHLIB_NAME} ${SHLIB_LINK}
160.endif
161.endif
162	@touch $@
163.endif
164
165.if !empty(STAGE_DIR)
166STAGE_SETS += _default
167STAGE_DIR._default = ${STAGE_DIR}
168STAGE_LINKS_DIR._default = ${STAGE_LINKS_DIR:U${STAGE_OBJTOP}}
169STAGE_SYMLINKS_DIR._default = ${STAGE_SYMLINKS_DIR:U${STAGE_OBJTOP}}
170STAGE_FILES._default = ${STAGE_FILES}
171STAGE_LINKS._default = ${STAGE_LINKS}
172STAGE_SYMLINKS._default = ${STAGE_SYMLINKS}
173STAGE_FILES ?= ${.ALLSRC:N.dirdep:Nstage_*}
174STAGE_SYMLINKS ?= ${.ALLSRC:T:N.dirdep:Nstage_*}
175.endif
176
177.if !empty(STAGE_SETS)
178CLEANFILES += ${STAGE_SETS:@s@stage*$s@}
179
180# some makefiles need to populate multiple directories
181.for s in ${STAGE_SETS:O:u}
182STAGE_FILES.$s ?= ${.ALLSRC:N.dirdep:Nstage_*}
183STAGE_SYMLINKS.$s ?= ${.ALLSRC:N.dirdep:Nstage_*}
184STAGE_LINKS_DIR.$s ?= ${STAGE_OBJTOP}
185STAGE_SYMLINKS_DIR.$s ?= ${STAGE_OBJTOP}
186
187STAGE_TARGETS += stage_files
188.if $s != "_default"
189stage_files:	stage_files.$s
190stage_files.$s:	.dirdep
191.else
192stage_files:	.dirdep
193.endif
194	@${STAGE_FILE_SCRIPT}; StageFiles ${FLAGS.$@} ${STAGE_FILES_DIR.$s:U${STAGE_DIR.$s}:${STAGE_DIR_FILTER}} ${STAGE_FILES.$s}
195	@touch $@
196
197STAGE_TARGETS += stage_links
198.if $s != "_default"
199stage_links:	stage_links.$s
200stage_links.$s:	.dirdep
201.else
202stage_links:	.dirdep
203.endif
204	@${STAGE_LINKS_SCRIPT}; StageLinks ${STAGE_LINKS_DIR.$s:U${STAGE_DIR.$s}:${STAGE_DIR_FILTER}} ${STAGE_LINKS.$s}
205	@touch $@
206
207STAGE_TARGETS += stage_symlinks
208.if $s != "_default"
209stage_symlinks:	stage_symlinks.$s
210stage_symlinks.$s:	.dirdep
211.else
212stage_symlinks:	.dirdep
213.endif
214	@${STAGE_LINKS_SCRIPT}; StageLinks -s ${STAGE_SYMLINKS_DIR.$s:U${STAGE_DIR.$s}:${STAGE_DIR_FILTER}} ${STAGE_SYMLINKS.$s}
215	@touch $@
216
217.endfor
218.endif
219
220.if !empty(STAGE_AS_SETS)
221CLEANFILES += ${STAGE_AS_SETS:@s@stage*$s@}
222
223STAGE_TARGETS += stage_as
224
225# sometimes things need to be renamed as they are staged
226# each ${file} will be staged as ${STAGE_AS_${file:T}}
227# one could achieve the same with SYMLINKS
228.for s in ${STAGE_AS_SETS:O:u}
229STAGE_AS.$s ?= ${.ALLSRC:N.dirdep:Nstage_*}
230
231stage_as:	stage_as.$s
232stage_as.$s:	.dirdep
233	@${STAGE_AS_SCRIPT}; StageAs ${FLAGS.$@} ${STAGE_FILES_DIR.$s:U${STAGE_DIR.$s}:${STAGE_DIR_FILTER}} ${STAGE_AS.$s:@f@$f ${STAGE_AS_${f:tA}:U${STAGE_AS_${f:T}:U${f:T}}}@}
234	@touch $@
235
236.endfor
237.endif
238
239CLEANFILES += ${STAGE_TARGETS} stage_incs stage_includes
240
241# stage_*links usually needs to follow any others.
242# for non-jobs mode the order here matters
243staging: ${STAGE_TARGETS:N*_links} ${STAGE_TARGETS:M*_links}
244
245.if ${.MAKE.JOBS:U0} > 0 && ${STAGE_TARGETS:U:M*_links} != ""
246# the above isn't sufficient
247.for t in ${STAGE_TARGETS:N*links:O:u}
248.ORDER: $t stage_links
249.endfor
250.endif
251
252# generally we want staging to wait until everything else is done
253STAGING_WAIT ?= .WAIT
254
255.if ${.MAKE.LEVEL} > 0
256all: ${STAGING_WAIT} staging
257.endif
258
259.if exists(${.PARSEDIR}/stage-install.sh) && !defined(STAGE_INSTALL)
260# this will run install(1) and then followup with .dirdep files.
261STAGE_INSTALL := sh ${.PARSEDIR:tA}/stage-install.sh INSTALL="${INSTALL}" OBJDIR=${.OBJDIR:tA}
262.endif
263
264# if ${INSTALL} gets run during 'all' assume it is for staging?
265.if ${.TARGETS:Nall} == "" && defined(STAGE_INSTALL)
266INSTALL := ${STAGE_INSTALL}
267.if target(beforeinstall)
268beforeinstall: .dirdep
269.endif
270.endif
271.NOPATH: ${STAGE_FILES}
272
273.if !empty(STAGE_TARGETS)
274.NOPATH: ${CLEANFILES}
275
276MK_STALE_STAGED?= no
277.if ${MK_STALE_STAGED} == "yes"
278all: stale_staged
279# get a list of paths that we have just staged
280# get a list of paths that we have previously staged to those same dirs
281# anything in the 2nd list but not the first is stale - remove it.
282stale_staged: staging .NOMETA
283	@egrep '^[WL] .*${STAGE_OBJTOP}' /dev/null ${.MAKE.META.FILES:M*stage_*} | \
284	sed "/\.dirdep/d;s,.* '*\(${STAGE_OBJTOP}/[^ '][^ ']*\).*,\1," | \
285	sort > ${.TARGET}.staged1
286	@grep -l '${_dirdep}' /dev/null ${_STAGED_DIRS:M${STAGE_OBJTOP}*:O:u:@d@$d/*.dirdep@} | \
287	sed 's,\.dirdep,,' | sort > ${.TARGET}.staged2
288	@comm -13 ${.TARGET}.staged1 ${.TARGET}.staged2 > ${.TARGET}.stale
289	@test ! -s ${.TARGET}.stale || { \
290		echo "Removing stale staged files..."; \
291		sed 's,.*,& &.dirdep,' ${.TARGET}.stale | xargs rm -f; }
292
293.endif
294.endif
295.endif
296