xref: /netbsd-src/distrib/common/Makefile.bootcd (revision f9a956b2348368b206db2765ce89502fc2c47a9e)
1#	$NetBSD: Makefile.bootcd,v 1.55 2024/05/16 17:55:48 christos Exp $
2#
3# Makefile snipped to create a CD/DVD ISO
4#
5
6# XXX TODO:
7# 1) merge with src/distrib/cdrom
8# 2) teach makefs to add data from more than 1 directory (see below)
9
10#
11# Required variables:
12#	CDBASE		Basename of the iso
13#
14# Optional variables:
15#	CDRELEASE	Set to 'true' to include $RELEASEDIR/$RELEASEMACHINEDIR on the CD
16#	CDRELEASE_NOISOS Excludes installation/cdrom directory if set
17#	CDRELEASE_NODEBUG	Excludes debug sets if set
18#	CDSOURCE	Set to 'true' to include $RELEASEDIR/source on the CD
19#	CDEXTRA		Set to a list of files or directories containing extra
20#			stuff to put on CD (set by build.sh -C flag)
21#	CDBUILDEXTRA	Set to a list of files or directories containing extra
22#			stuff to put on CD (use in Makefiles)
23#	CDEXTRA_SKIP	A list of file exclusion paths to exclude when copying
24#			directories of extra stuff in CDEXTRA AND CDBUILDEXTRA
25#	CDDEV_POPULATE	Set to 'true' to fully populate /dev on the CD (and
26#			safe a tmpfs union mount)
27#	BOOT		Defaults to $DESTDIR/usr/mdec/boot
28#	BOOTXX_CD9660	Defaults to $DESTDIR/usr/mdec/bootxx_cd9660
29#	CDBOOTOPTIONS	Options for installboot, eg -o console=com0,speed=9600
30#	CDMAKEFSOPTIONS	Options for makefs, eg bootimage=i386;bootxx,no-emul-boot
31#	CDMAKEFSEXTRAOPTS additional options for makefs, e.g. -F specfile
32#	CDROMS_RELEASEDIR Where to install ${CDBASE}.iso
33#	CDINSTKERNEL	instkernel directory (relative to ${.CURDIR})
34#	CDKERNELS	couples of the form:
35#				source	name_on_cd
36#	CDRUNTIME	files/directories to copy from $DESTDIR onto the CD
37#	CD_SETS		sets to be extracted onto the CD
38#	SETS_DIR	where the CD_SETS are found (default provided)
39# source kernels are copied from ${CDINSTKERNEL} (or its obj dir)
40# note that as of yet, bootxx_cd9660 can't load kernel names of more than
41# 8 chars (though they can be in a sub-directory meaning the pathname is
42# longer than 8 chars)
43#
44
45BOOT?=		${DESTDIR}/usr/mdec/boot
46BOOTXX_CD9660?=	${DESTDIR}/usr/mdec/bootxx_cd9660
47CDRELEASE?=	false
48CDSOURCE?=	false
49CDDEV_POPULATE?=false
50.if ${CDRELEASE} == false
51CDROMS_RELEASEDIR?=	${MACHINE}/installation/cdrom
52.else
53CDROMS_RELEASEDIR?=	images
54.endif
55.if defined(CDRELEASE_NOISOS)
56CDRELEASE_EXCLUDE+=	-s ',./installation/cdrom.*,,gp'
57.endif
58.if defined(CDRELEASE_NOCOMPAT)
59.  for sufx in tgz tar.xz
60CDRELEASE_EXCLUDE+=	-s ',./binary/sets/base32.${sufx},,gp'
61CDRELEASE_EXCLUDE+=	-s ',./binary/sets/base64.${sufx},,gp'
62.  endfor
63.endif
64.if defined(CDRELEASE_NODEBUG)
65.  for sufx in tgz tar.xz
66CDRELEASE_EXCLUDE+=	-s ',./binary/sets/debug.${sufx},,gp'
67CDRELEASE_EXCLUDE+=	-s ',./binary/sets/debug32.${sufx},,gp'
68CDRELEASE_EXCLUDE+=	-s ',./binary/sets/debug64.${sufx},,gp'
69CDRELEASE_EXCLUDE+=	-s ',./binary/sets/xdebug.${sufx},,gp'
70.  endfor
71.endif
72.if defined(CDRELEASE_NOHTML)
73.  for sufx in tgz tar.xz
74CDRELEASE_EXCLUDE+=	-s ',./binary/sets/manhtml.${sufx},,gp'
75.  endfor
76.endif
77.if defined(CDRELEASE_NOTESTS)
78.  for sufx in tgz tar.xz
79CDRELEASE_EXCLUDE+=	-s ',./binary/sets/tests.${sufx},,gp'
80.  endfor
81.endif
82.if !defined(CDRELEASE_LIVEIMAGE)
83CDRELEASE_EXCLUDE+=	-s ',./installation/liveimage.*,,gp'
84.endif
85.if !defined(CDRELEASE_INSTALLIMAGE)
86CDRELEASE_EXCLUDE+=	-s ',./installation/installimage.*,,gp'
87.endif
88
89SETS_DIR?=	${RELEASEDIR}/${RELEASEMACHINEDIR}/binary/sets
90
91.include <bsd.own.mk> 		# For PRINTOBJDIR
92.include <bsd.kernobj.mk>	# For KERNSRCDIR
93
94DISTRIBVER!=	${HOST_SH} ${KERNSRCDIR}/conf/osrelease.sh
95DISTRIBREV!=	${HOST_SH} ${KERNSRCDIR}/conf/osrelease.sh -s
96CUROBJDIR!=	cd ${.CURDIR} && ${PRINTOBJDIR}
97ISO_VOLID!=	echo NETBSD_${DISTRIBREV} | tr a-z A-Z
98PUBLISHER?= The_NetBSD_Project
99.if defined(CDMAKEFSOPTIONS)
100_CDMAKEFSOPTIONS=	rockridge,label=${ISO_VOLID},publisher=${PUBLISHER},${CDMAKEFSOPTIONS}
101.else
102_CDMAKEFSOPTIONS=	rockridge,label=${ISO_VOLID},publisher=${PUBLISHER}
103.endif
104
105.if ${MKREPRO_TIMESTAMP:Uno} != "no"
106MAKEFS_TIMESTAMP=-T "${MKREPRO_TIMESTAMP}"
107PAX_TIMESTAMP=--timestamp "${MKREPRO_TIMESTAMP}"
108.endif
109MAKESPEC=	${HOST_SH} ${NETBSDSRCDIR}/etc/makespec
110
111.if ${MKUNPRIVED} == "no"
112CD_METALOG.unpriv=
113mtunpriv=
114.else
115CD_METALOG.unpriv=-M ${METALOG}.sanitised
116mtunpriv="-U"
117.endif
118
119# Stuff that should come from elsewhere - XXX where? - HF
120RM?=		rm
121MKDIR?=		mkdir -p
122CHMOD?=		chmod
123ECHO?=		echo
124
125.if ${CDRELEASE} == false
126CDIMAGE=	${CDBASE}.iso
127.elif ${CDBASE:M*dvd}
128CDIMAGE=	NetBSD-${DISTRIBVER}-${CDBASE:S/dvd$//}-dvd.iso
129.else
130CDIMAGE=	NetBSD-${DISTRIBVER}-${CDBASE:S/cd$//}.iso
131.endif
132WORKSPEC=	fs.spec
133
134CLEANFILES+=	${CDIMAGE}
135CLEANFILES+=	bootxx.${MACHINE}
136CLEANFILES+=	${WORKSPEC}
137
138CDSETSENV=	DESTDIR=${DESTDIR:Q} \
139		MACHINE=${MACHINE:Q} \
140		MACHINE_ARCH=${MACHINE_ARCH:Q} \
141		AWK=${TOOL_AWK:Q} \
142		CKSUM=${TOOL_CKSUM:Q} \
143		DB=${TOOL_DB:Q} \
144		HOST_SH=${HOST_SH:Q} \
145		MAKE=${MAKE:Q} \
146		MKTEMP=${TOOL_MKTEMP:Q} \
147		MTREE=${TOOL_MTREE:Q} \
148		PAX=${TOOL_PAX:Q} \
149		COMPRESS_PROGRAM=${COMPRESS_PROGRAM:Q} \
150		GZIP=${GZIP_FLAGS:Q} \
151		PKG_CREATE=${TOOL_PKG_CREATE:Q} \
152		SED=${TOOL_SED:Q} \
153		TSORT=${TSORT:Q} \
154		MKRUMP=no \
155		MKCOMPAT=no \
156		MKDEBUG=no \
157		MKDEBUGLIB=no
158
159CDSETSCMD=	cd ${NETBSDSRCDIR}/distrib/sets && \
160		${CDSETSENV} \
161		${HOST_SH}
162
163.include "${NETBSDSRCDIR}/distrib/common/Makefile.distrib"
164
165.if defined(CDINSTKERNEL)
166_INSTKERNELNOBJDIR!=	cd ${.CURDIR}/${CDINSTKERNEL} && ${PRINTOBJDIR}
167.endif
168.if exists(${DESTDIR}/usr/mdec/bootxx_cd9660)
169.if exists(${DESTDIR}/usr/mdec/boot.${MACHINE})
170BOOT2=boot.${MACHINE}
171.else
172BOOT2=boot
173.endif
174.endif
175
176prepare:
177	${MKDIR} ${MKDIRPERM} "${CUROBJDIR}/cdrom"
178.if defined(CDKERNELS)
179.for kernel target in ${CDKERNELS}
180	${INSTALL} ${COPY} -m 0644 ${_INSTKERNELNOBJDIR}/${kernel} cdrom/${target}
181.endfor
182.if exists(${DESTDIR}/usr/mdec/bootxx_cd9660)
183	${RM} -f cdrom/${BOOT2}
184	${INSTALL} ${COPY} -m 0644 ${DESTDIR}/usr/mdec/${BOOT2} cdrom/${BOOT2}
185	${RM} -f bootxx.${MACHINE}
186	${INSTALL} ${COPY} -m 0644 ${DESTDIR}/usr/mdec/bootxx_cd9660 bootxx.${MACHINE}
187	${CHMOD} +w bootxx.${MACHINE}
188.if defined(CDBOOTOPTIONS)
189	${TOOL_INSTALLBOOT} -m${MACHINE} -e ${CDBOOTOPTIONS} bootxx.${MACHINE}
190.endif
191.endif
192.endif
193
194.if ${MAKEVERBOSE} >= 2
195PAX_v?= -v
196.else
197PAX_v?=
198.endif
199
200# Copy $RELEASEDIR/${MACHINE} in the CDROM dir
201#
202# XXX This could be done a lot easier if makefs(8) could
203# XXX include more than one directory on the image - HF
204#
205copy-releasedir:
206	${RM} -f ${RELEASEDIR}/${CDROMS_RELEASEDIR}/${CDIMAGE}
207	if ${CDRELEASE}; then 						\
208		if [ ! -d ${RELEASEDIR}/${RELEASEMACHINEDIR} ]; then 	\
209			echo "Missing ${RELEASEDIR}/${RELEASEMACHINEDIR}, aborting"; \
210			exit 1; 					\
211		fi; 							\
212		${MKDIR} ${MKDIRPERM} "${CUROBJDIR}/cdrom/${RELEASEMACHINEDIR}"; 	\
213		release_destdir="${CUROBJDIR}/cdrom/${RELEASEMACHINEDIR}";	\
214		cd ${RELEASEDIR}/${RELEASEMACHINEDIR}; 			\
215		echo Copying $$(pwd) to $$release_destdir ...; 		\
216		${TOOL_PAX} ${PAX_TIMESTAMP}				\
217			-rw -pe ${PAX_v}				\
218			${CDRELEASE_EXCLUDE}				\
219			. $$release_destdir; 				\
220		cd "${CUROBJDIR}";					\
221	fi
222	if ${CDSOURCE}; then 						\
223		if [ ! -d ${RELEASEDIR}/source ]; then	 		\
224			echo "Missing ${RELEASEDIR}/source, aborting"; 	\
225			exit 1; 					\
226		fi; 							\
227		${MKDIR} ${MKDIRPERM} "${CUROBJDIR}/cdrom/source"; 	\
228		release_destdir="${CUROBJDIR}/cdrom/source";	 	\
229		cd ${RELEASEDIR}/source; 				\
230		echo Copying $$(pwd) to $$release_destdir ...;		\
231		${TOOL_PAX} ${PAX_TIMESTAMP} 				\
232			-rw -pe ${PAX_v}				\
233			. $$release_destdir; 				\
234		cd "${CUROBJDIR}";					\
235	fi
236	if [ "X${CDRUNTIME}" != "X" ]; then				\
237		release_destdir=$${curdir}/cdrom;			\
238		cd $$release_destdir;					\
239		cd ${DESTDIR};						\
240		for cde in ${CDRUNTIME};				\
241		do							\
242			${TOOL_PAX} ${PAX_TIMESTAMP} -rw -pp ${PAX_v}	\
243				$${cde} $$release_destdir;		\
244		done;							\
245		cd "${CUROBJDIR}";					\
246	fi
247	if [ "X${CDEXTRA}${CDBUILDEXTRA}" != "X" ]; then		\
248		skipflag="";						\
249		cdextra_skip="${CDEXTRA_SKIP}";				\
250		if [ "X$${cdextra_skip}" != "X" ]; then			\
251			rm -f cdskip;					\
252			for skip in $${cdextra_skip};			\
253			do						\
254				echo $${skip} >> cdskip;		\
255			done;						\
256			skipflag="-X ${CUROBJDIR:Q}/cdskip";		\
257		fi;							\
258		cdextra="${CDEXTRA}"; 					\
259		cdbuildextra="${CDBUILDEXTRA}"; 			\
260		for cde in $${cdextra} $${cdbuildextra};		\
261		do							\
262			release_destdir="${CUROBJDIR}/cdrom";		\
263			if [ -f $${cde} ]; then				\
264				echo Copying $${cde} to $$release_destdir ...;	\
265				${INSTALL} ${COPY} -m 0644 $${cde} $${release_destdir};	\
266			elif [ -d $${cde} ]; then			\
267				cd $${cde};				\
268				echo Copying $$(pwd) to $$release_destdir ...;	\
269				${TOOL_MTREE} -c $${skipflag} |		\
270					${TOOL_PAX} ${PAX_TIMESTAMP}	\
271					-rw -pe ${PAX_v}		\
272					-M $$release_destdir; 		\
273			else						\
274				echo "Missing $${cde}, aborting"; 	\
275				exit 1; 				\
276			fi; 						\
277			cd "${CUROBJDIR}";				\
278		done;							\
279	fi
280.if !empty(CD_SETS)
281	${MKDIR} ${MKDIRPERM} "${CUROBJDIR}/cdrom/etc/mtree"
282.for set in ${CD_SETS}
283	if [ -f ${CUROBJDIR:Q}/cdrom/etc/mtree/set.${set} ]; then	\
284		${CHMOD} +w ${CUROBJDIR:Q}/cdrom/etc/mtree/set.${set};	\
285	fi;								\
286	${CDSETSCMD} ./maketars -i "${CUROBJDIR}/cdrom"			\
287	    ${CD_METALOG.unpriv} ${mtunpriv} -N ${NETBSDSRCDIR}/etc	\
288	    -xx -F "${CUROBJDIR}/cdrom/etc/mtree" 			\
289	    -d "${DESTDIR:S,^$,/,}" ${set}
290.endfor
291	if [ -d "${CUROBJDIR}/cdrom/var/spool/ftp/hidden" ]; then	\
292		${CHMOD} +r "${CUROBJDIR}/cdrom/var/spool/ftp/hidden";	\
293	fi
294.endif
295
296.if ${CDDEV_POPULATE} != true
297DELDEV=-e '/^\.\/dev\/.*type=char/d'
298.endif
299
300image:
301	@echo Preparing spec files for makefs...
302	${RM} -f ${WORKSPEC}
303	if [ -d cdrom/etc/mtree ]; then				\
304		cat cdrom/etc/mtree/* |				\
305		    ${TOOL_SED} -e 's/ size=[0-9]*//'		\
306		     ${DELDEV}					\
307		     -e '/^\.\/etc\/gettytab/d' > ${WORKSPEC};	\
308	fi
309	if [ -r cdrom/dev/MAKEDEV ] &&				\
310		 ${CDDEV_POPULATE} == true; then		\
311		${HOST_SH} cdrom/dev/MAKEDEV -s init |		\
312		    ${TOOL_SED} -e '/^\. type=dir/d' 		\
313			-e 's,^\.,./dev,' >> ${WORKSPEC};	\
314	fi
315.if defined(SPEC_IN)
316	cat ${SPEC_IN} >> ${WORKSPEC}
317.endif
318.if defined(SECONDARY_BOOT)
319	echo "./${SECONDARY_BOOT} type=file uname=root gname=wheel mode=0444" \
320	    >> ${WORKSPEC}
321.endif
322.if defined(SPEC_EXTRA)
323	cat ${SPEC_EXTRA} >> ${WORKSPEC}
324.endif
325	if [ ! -s ${WORKSPEC} ]; then \
326	    ${MAKESPEC} -d cdrom . > ${WORKSPEC}; \
327	else \
328	    for i in ${RELEASEMACHINEDIR} source ${CDEXTRA} ${CDBUILDEXTRA}; do\
329		if [ -n "$$i" ] && [ -e cdrom/$$i ]; then \
330		    ${MAKESPEC} -d cdrom $$i >> ${WORKSPEC}; \
331		fi; \
332	    done; \
333	fi
334	${TOOL_MAKEFS} -N ${NETBSDSRCDIR}/etc -t cd9660 -F ${WORKSPEC} -xx \
335	    ${MAKEFS_TIMESTAMP} ${CDMAKEFSEXTRAOPTS} -o ${_CDMAKEFSOPTIONS:Q} \
336	    ${CDIMAGE} cdrom
337
338.if ${CDRELEASE} == false
339release: prepare .WAIT prepare_md_post .WAIT copy-releasedir .WAIT image_md_pre .WAIT image .WAIT image_md_post
340	${MKDIR} ${MKDIRPERM} ${RELEASEDIR}/${CDROMS_RELEASEDIR}
341	${RELEASE_INSTALL} ${CDIMAGE} ${RELEASEDIR}/${CDROMS_RELEASEDIR}
342
343iso_image:
344.else
345release:
346
347iso_image: prepare .WAIT prepare_md_post .WAIT copy-releasedir .WAIT image_md_pre .WAIT image .WAIT image_md_post
348	${MKDIR} ${MKDIRPERM} ${RELEASEDIR}/${CDROMS_RELEASEDIR}
349	${RELEASE_INSTALL} ${CDIMAGE} ${RELEASEDIR}/${CDROMS_RELEASEDIR}
350.endif
351
352clean:
353	@if [ -d cdrom/var/spool/ftp/hidden ]; then 		\
354		${CHMOD} +r cdrom/var/spool/ftp/hidden;		\
355	fi	# XXX
356	${RM} -fr cdrom
357
358prepare_md_post: .PHONY
359image_md_post: .PHONY
360image_md_pre: .PHONY
361
362.include <bsd.prog.mk>
363