Makefile.bootimage revision 1.18 
1#	$NetBSD: Makefile.bootimage,v 1.18 2018/10/07 18:07:00 martin Exp $
2#
3# Copyright (c) 2009, 2010, 2011 Izumi Tsutsui.  All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25#
26# Makefile to create a bootable FS image for USB flash or emulators
27#
28
29#
30# Required variables:
31#	RELEASEDIR
32#		Should be defined in nbmake-${MACHINE}
33#	IMGBASE
34#		Basename of the image
35#
36# Optional variables:
37#	BOOTDISK
38#		device name of target bootable disk specified in /etc/fstab
39#		(default: sd0)
40#	USE_MBR
41#		set yes if target disk image requires MBR partition
42#		(default: no)
43#	MBR_BOOTCODE
44#		optional MBR bootcode which should be installed by fdisk(8)
45#		(default: empty)
46#		- specified MBR_BOOTCODE must exist in ${DESTDIR}/usr/mdec
47#		- if MBR_BOOTCODE is not specified,
48#		  MBR_DEFAULT_BOOTCODE (default: mbr) will be used
49#		  if the target ${MACHINE} has the one in /usr/mdec
50#	USE_SUNLABEL
51#		set yes if target disk image requires Sun's label
52#		(default: no)
53#	INSTALLBOOT_AFTER_DISKLABEL (untested)
54#		set yes if the target ${MACHINE} requires disklabel
55#		to run installboot(8), like hp300
56#		(default: empty)
57#	IMAGEMB
58#		target image size in MB
59#		(default: 2048)
60#	SWAPMB
61#		swap size in target image in MB
62#		(default: 128)
63#	KERN_SET
64#		kernel set name which should be extracted into image
65#		(default: kern-GENERIC)
66#	SETS
67#		binary sets that should be extracted into image
68#		(default: modules base etc comp games man misc tests text
69#			  xbase xcomp xetc xfont xserver)
70#	SETS_DIR
71#		directory path where binary sets are stored
72#		(default: ${RELEASEDIR}/${RELEASEMACHINEDIR}/binary/sets)
73#	IMGFILE_EXTRA
74#		list of additional files to be copied into images,
75#		containing one or more tuples of the form:
76#			FILE	TARGETPATH
77#		for installation image etc.
78#		(default: empty)
79#	IMGDIR_EXTRA
80#		list of additional directories to be copied into images,
81#		containing one or more tuples of the form:
82#			DIR	TARGETPATH
83#		for installation image etc.
84#		(default: empty)
85#		XXX: currently permissions in IMGDIR_EXTRA are not handled
86#	IMGDIR_EXCLUDE
87#		pax(1) options to exclude files which should not copied
88#		into TARGETPATH in IMGDIR_EXTRA
89#		(default: empty)
90#	FSTAB_IN
91#		template file of /etc/fstab
92#		(default: ${DISTRIBDIR}/common/bootimage/fstab.in)
93#	SPEC_IN
94#		default files of spec file for makefs(8)
95#		(default: ${DISTRIBDIR}/common/bootimage/spec.in)
96#	SPEC_EXTRA
97#		additional files of spec file for makefs(8)
98#		(default: empty)
99#	IMGMAKEFSOPTIONS
100#		options passed to makefs(8) to create root file system
101#		(default: -o bsize=16384,fsize=2048,density=8192)
102#	INSTALLBOOTOPTIONS
103#		options passed to installboot(8), e.g., -o console=com0
104#		(default: empty)
105#	PRIMARY_BOOT
106#		primary boot loader that should be installed into
107#		the target image via installboot(8)
108#		(default: empty)
109#	SECONDARY_BOOT
110#		secondary bootloader that should be put into the target image
111#		(default: empty)
112#	SECONDARY_BOOT_ARG
113#		extra arguments that should be passed to installboot(8)
114#		to specify the secondary bootloader
115#		(default: empty)
116#	DISKPROTO_IN
117#		template file of disklabel -R
118#		(default: ${DISTRIBDIR}/common/bootimage/diskproto.in
119#		       or ${DISTRIBDIR}/common/bootimage/diskproto.mbr.in)
120#	OMIT_SWAPIMG
121#		no need to put swap partition into image (for USB stick)
122#		(default: no)
123#
124
125.include <bsd.own.mk> 		#
126.include <bsd.endian.mk>	# for TARGET_ENDIANNESS
127
128.include "${NETBSDSRCDIR}/distrib/common/Makefile.distrib"
129
130.if ${MKREPRO_TIMESTAMP:Uno} != "no"
131MAKEFS_TIMESTAMP=-T "${MKREPRO_TIMESTAMP}"
132PAX_TIMESTAMP=--timestamp "${MKREPRO_TIMESTAMP}"
133.endif
134
135.if empty(IMGBASE)
136.BEGIN:
137	@echo "Error: IMGBASE is not set"
138	@false
139.endif
140
141# should be defined elsewhere? 
142CAT?=		cat
143CHMOD?=		chmod
144DD?=		dd
145MKDIR?=		mkdir -p
146RM?=		rm
147
148#
149# common definitions for image
150#
151BOOTDISK?=	sd0
152USE_MBR?=	no
153USE_SUNLABEL?=	no
154INSTALLBOOT_AFTER_DISKLABEL?=	no
155
156#
157# size parameters for image
158#
159IMAGEMB?=	2048		# 2048MB
160SWAPMB?=	128		# 128MB
161
162# XXX: SWAPMB could be zero and expr(1) returns exit status 1 in that case
163IMAGESECTORS!=	expr ${IMAGEMB} \* 1024 \* 1024 / 512
164SWAPSECTORS!=	expr ${SWAPMB} \* 1024 \* 1024 / 512 || true
165
166.if ${USE_MBR} == "no"
167LABELSECTORS?=	0
168.else
169#LABELSECTORS?=	63	# historical
170#LABELSECTORS?=	32	# 16KB aligned
171LABELSECTORS?=	2048	# 1MB aligned for modern flash devices
172.endif
173
174FSSECTORS!=	expr ${IMAGESECTORS} - ${SWAPSECTORS} - ${LABELSECTORS}
175FSSIZE!=	expr ${FSSECTORS} \* 512
176
177# parameters for disklabel and MBR
178HEADS=		64
179SECTORS=	32
180CYLINDERS!=	expr ${IMAGESECTORS} / \( ${HEADS} \* ${SECTORS} \)
181SECPERCYLINDERS!= expr ${HEADS} \* ${SECTORS}
182MBRHEADS=	255
183MBRSECTORS=	63
184MBRCYLINDERS!=	expr ${IMAGESECTORS} / \( ${MBRHEADS} \* ${MBRSECTORS} \)
185MBRNETBSD=	169
186
187BSDPARTSECTORS!= expr ${IMAGESECTORS} - ${LABELSECTORS}
188FSOFFSET=	${LABELSECTORS}
189SWAPOFFSET!=	expr ${LABELSECTORS} + ${FSSECTORS}
190
191# parameters for sunlabel
192FSCYLINDERS!=	expr ${FSSECTORS} / \( ${HEADS} \* ${SECTORS} \)
193SWAPCYLINDERS!=	expr ${SWAPSECTORS} / \( ${HEADS} \* ${SECTORS} \) || true
194
195
196#
197# definitions to create root fs
198#
199SETS_DEFAULT=	modules base etc comp games man misc tests text
200.if ${MKX11} != "no"
201SETS_DEFAULT+=	xbase xcomp xetc xfont xserver
202.endif
203
204KERN_SET?=	kern-GENERIC
205SETS?=		${SETS_DEFAULT}
206IMG_SETS=	${KERN_SET} ${SETS}
207SETS_DIR?=	${RELEASEDIR}/${RELEASEMACHINEDIR}/binary/sets
208
209FSTAB_IN?=	${DISTRIBDIR}/common/bootimage/fstab.in
210SPEC_IN?=	${DISTRIBDIR}/common/bootimage/spec.in
211
212IMGMAKEFSOPTIONS?=	-o bsize=16384,fsize=2048,density=8192
213
214WORKDIR?=       work
215WORKSPEC?=      work.spec
216WORKFSTAB?=	work.fstab
217WORKRCCONF?=	work.rc.conf
218WORKFS?=        work.rootfs
219TARGETFS?=      imgroot.fs
220TAR_SUFF=	${"${USE_XZ_SETS:Uno}"!="no":?tar.xz:tgz}
221
222CLEANFILES+=	${WORKSPEC} ${WORKFSTAB} ${WORKRCCONF} ${WORKFS}
223CLEANFILES+=	${TARGETFS}
224
225#
226# create root file system for the image
227#
228${TARGETFS}: prepare_md_post
229	@if [ ! -d ${RELEASEDIR}/${RELEASEMACHINEDIR} ]; then 		\
230		echo "Missing ${RELEASEDIR}/${RELEASEMACHINEDIR}, aborting"; \
231		false; 							\
232	fi;
233	@${MKDIR} ${MKDIRPERM} ${WORKDIR}
234.for set in ${IMG_SETS}
235	@if [ ! -f ${SETS_DIR}/${set}.${TAR_SUFF} ]; then 		\
236		echo "Missing ${SETS_DIR}/${set}.${TAR_SUFF}, aborting";\
237		false; 							\
238	fi
239	@echo Extracting ${set}.${TAR_SUFF} ...
240	@(cd ${WORKDIR}; ${TOOL_PAX} ${PAX_TIMESTAMP} -rnz -f ${SETS_DIR}/${set}.${TAR_SUFF} .)
241.endfor
242.if defined(SECONDARY_BOOT)
243	@echo Copying secondary boot...
244	${INSTALL} ${COPY} -m 0644 ${WORKDIR}/usr/mdec/${SECONDARY_BOOT} ${WORKDIR}
245.endif
246	@echo Preparing /etc/fstab ...
247	${TOOL_SED} "s/@@BOOTDISK@@/${BOOTDISK}/" < ${FSTAB_IN} > ${WORKFSTAB}
248	${INSTALL} ${COPY} -m 0644 ${WORKFSTAB} ${WORKDIR}/etc/fstab
249	@echo Setting rc_configured=YES in /etc/rc.conf ...
250	${TOOL_SED} "s/rc_configured=NO/rc_configured=YES/"		\
251	    < ${WORKDIR}/etc/rc.conf > ${WORKRCCONF}
252	${INSTALL} ${COPY} -m 0644 ${WORKRCCONF} ${WORKDIR}/etc/rc.conf
253.if defined(IMGDIR_EXTRA)
254	@echo Copying extra dirs...
255.for _SRCDIR _TARGET in ${IMGDIR_EXTRA}
256	@if [ ! -d ${_SRCDIR} ]; then 					\
257		echo "${_SRCDIR} is not directory, aborting";		\
258		false; 							\
259	fi
260	${MKDIR} ${MKDIRPERM} ${WORKDIR}/${_TARGET}
261	(cd ${_SRCDIR} ;						\
262	    ${TOOL_PAX} -rw -pe	-v ${PAX_TIMESTAMP}			\
263	    ${IMGDIR_EXCLUDE}						\
264	    . ${.OBJDIR}/${WORKDIR}/${_TARGET} )
265.endfor
266.endif
267.if defined(IMGFILE_EXTRA)
268	@echo Copying extra files...
269.for _SRC _TARGET in ${IMGFILE_EXTRA}
270	@if [ ! -f ${_SRC} ]; then 					\
271		echo "${_SRC} in IMGFILE_EXTRA not found, aborting";	\
272		false; 							\
273	fi
274	@if [ -f ${_SRC} ]; then 					\
275		echo ${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET};		\
276		${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET};			\
277	fi
278.endfor
279.endif
280	@echo Preparing spec files for makefs...
281	${RM} -f ${WORKSPEC}
282	cat ${WORKDIR}/etc/mtree/* |					\
283	    ${TOOL_SED} -e 's/ size=[0-9]*//' > ${WORKSPEC}
284	${HOST_SH} ${WORKDIR}/dev/MAKEDEV -s all ipty |			\
285	    ${TOOL_SED} -e '/^\. type=dir/d' -e 's,^\.,./dev,' >> ${WORKSPEC}
286	cat ${SPEC_IN} >> ${WORKSPEC}
287.if defined(SECONDARY_BOOT)
288	echo "./${SECONDARY_BOOT} type=file uname=root gname=wheel mode=0444" \
289	    >> ${WORKSPEC}
290.endif
291.if defined(SPEC_EXTRA)
292	cat ${SPEC_EXTRA} >> ${WORKSPEC}
293.endif
294	@echo Creating rootfs...
295	# XXX /var/spool/ftp/hidden is unreadable
296	${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden
297	${TOOL_MAKEFS} -M ${FSSIZE} -m ${FSSIZE}			\
298	    -B ${TARGET_ENDIANNESS}					\
299	    -F ${WORKSPEC} -N ${WORKDIR}/etc				\
300	    ${MAKEFS_TIMESTAMP}						\
301	    ${IMGMAKEFSOPTIONS}						\
302	    ${WORKFS} ${WORKDIR}
303.if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} == "no"
304	${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKFS} \
305	    ${WORKDIR}/usr/mdec/${PRIMARY_BOOT} ${SECONDARY_BOOT_ARG}
306.endif
307	@echo done.
308	mv ${WORKFS} ${.TARGET}
309
310#
311# definitions to create image
312#
313.if ${USE_MBR} != "no"
314DISKPROTO_IN?=	${DISTRIBDIR}/common/bootimage/diskproto.mbr.in
315.else
316DISKPROTO_IN?=	${DISTRIBDIR}/common/bootimage/diskproto.in
317.endif
318
319MBR_DEFAULT_BOOTCODE?=	mbr
320
321OMIT_SWAPIMG?=	no
322
323WORKMBR?=	work.mbr
324WORKSWAP?=	work.swap
325WORKLABEL?=	work.diskproto
326WORKIMG?=	work.img
327
328CLEANFILES+=	${WORKMBR} ${WORKSWAP}
329CLEANFILES+=	${WORKLABEL}.tmp ${WORKLABEL}
330CLEANFILES+=	${WORKIMG} ${IMGBASE}.img
331
332${WORKLABEL}:
333	${TOOL_SED}							\
334	    -e "s/@@SECTORS@@/${SECTORS}/"				\
335	    -e "s/@@HEADS@@/${HEADS}/"					\
336	    -e "s/@@SECPERCYLINDERS@@/${SECPERCYLINDERS}/"		\
337	    -e "s/@@CYLINDERS@@/${CYLINDERS}/"				\
338	    -e "s/@@IMAGESECTORS@@/${IMAGESECTORS}/"			\
339	    -e "s/@@FSSECTORS@@/${FSSECTORS}/"				\
340	    -e "s/@@FSOFFSET@@/${FSOFFSET}/"				\
341	    -e "s/@@SWAPSECTORS@@/${SWAPSECTORS}/"			\
342	    -e "s/@@SWAPOFFSET@@/${SWAPOFFSET}/"			\
343	    -e "s/@@BSDPARTSECTORS@@/${BSDPARTSECTORS}/"		\
344	    < ${DISKPROTO_IN} > ${WORKLABEL}.tmp
345	mv ${WORKLABEL}.tmp ${WORKLABEL}
346
347${IMGBASE}.img:	${TARGETFS} ${WORKLABEL}
348.if ${USE_MBR} != "no"
349	@echo creating MBR labels...
350	${DD} if=/dev/zero of=${WORKMBR} seek=$$((${IMAGESECTORS} - 1)) count=1
351	${TOOL_FDISK} -f -i -u \
352	    -b ${MBRCYLINDERS}/${MBRHEADS}/${MBRSECTORS}		\
353	    -0 -a -s ${MBRNETBSD}/${FSOFFSET}/${BSDPARTSECTORS}		\
354	    -F ${WORKMBR}
355.if empty(MBR_BOOTCODE)
356	@if [ -f ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE} ]; then 	\
357		echo ${TOOL_FDISK} -f					\
358		    -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE}	\
359		    -F ${WORKMBR};					\
360		${TOOL_FDISK} -f					\
361		    -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE}	\
362		    -F ${WORKMBR};					\
363	fi
364.else
365	@if [ ! -f ${WORKDIR}/usr/mdec/${MBR_BOOTCODE} ]; then 		\
366		echo "${MBR_BOOTCODE} is not found in DESTDIR/usr/mdec, aborting"; \
367		false; 							\
368	fi
369	${TOOL_FDISK} -f -i -c ${WORKDIR}/usr/mdec/${MBR_BOOTCODE}	\
370	    -F ${WORKMBR}
371.endif
372	${DD} if=${WORKMBR} count=${LABELSECTORS} |			\
373	    ${CAT} - ${TARGETFS} > ${WORKIMG}
374.else
375	${INSTALL} ${COPY} -m 0644 ${TARGETFS} ${WORKIMG}
376.endif
377.if ${OMIT_SWAPIMG} == "no"
378	${DD} if=/dev/zero of=${WORKSWAP} seek=$$((${SWAPSECTORS} - 1)) count=1
379	${CAT} ${WORKSWAP} >> ${WORKIMG}
380.endif
381.if ${USE_SUNLABEL} != "no"
382	@echo Creating sun disklabel...
383	printf 'V ncyl %d\nV nhead %d\nV nsect %d\na %d %d/0/0\nb %d %d/0/0\nW\n' \
384	    ${CYLINDERS} ${HEADS} ${SECTORS} \
385	    ${FSOFFSET} ${FSCYLINDERS} ${FSCYLINDERS} ${SWAPCYLINDERS} | \
386	    ${TOOL_SUNLABEL} -nq ${WORKIMG}
387.endif
388	${TOOL_DISKLABEL} -R -F ${WORKIMG} ${WORKLABEL}
389.if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} != "no"
390	${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKIMG} \
391	    ${WORKDIR}/usr/mdec/${PRIMARY_BOOT}
392.endif
393	mv ${WORKIMG} ${.TARGET}
394
395
396CLEANFILES+=	${IMGBASE}.img.gz ${IMGBASE}.img.gz.tmp
397
398${IMGBASE}.img.gz:	${IMGBASE}.img
399	${TOOL_GZIP_N} -9c ${IMGBASE}.img > ${.TARGET}.tmp
400	mv ${.TARGET}.tmp ${.TARGET}
401
402clean:
403	@if [ -d ${WORKDIR}/var/spool/ftp/hidden ]; then 		\
404		${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden;		\
405	fi	# XXX
406	${RM} -fr ${WORKDIR}
407
408prepare_md_post: .PHONY
409image_md_post: .PHONY
410image_md_pre: .PHONY
411
412.include <bsd.prog.mk>
413