Makefile.bootimage revision 1.19 
1#	$NetBSD: Makefile.bootimage,v 1.19 2018/11/19 20:05:37 aymeric 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
220COMPRESS_PROGRAM=${"${USE_XZ_SETS:Uno}"!="no":?${TOOL_XZ}:${TOOL_GZIP}}
221TAR_SUFF=	${"${USE_XZ_SETS:Uno}"!="no":?tar.xz:tgz}
222
223CLEANFILES+=	${WORKSPEC} ${WORKFSTAB} ${WORKRCCONF} ${WORKFS}
224CLEANFILES+=	${TARGETFS}
225
226#
227# create root file system for the image
228#
229${TARGETFS}: prepare_md_post
230	@if [ ! -d ${RELEASEDIR}/${RELEASEMACHINEDIR} ]; then 		\
231		echo "Missing ${RELEASEDIR}/${RELEASEMACHINEDIR}, aborting"; \
232		false; 							\
233	fi;
234	@${MKDIR} ${MKDIRPERM} ${WORKDIR}
235.for set in ${IMG_SETS}
236	@if [ ! -f ${SETS_DIR}/${set}.${TAR_SUFF} ]; then 		\
237		echo "Missing ${SETS_DIR}/${set}.${TAR_SUFF}, aborting";\
238		false; 							\
239	fi
240	@echo Extracting ${set}.${TAR_SUFF} ...
241	@(cd ${WORKDIR}; ${TOOL_PAX} ${PAX_TIMESTAMP} -rn \
242		--use-compress-program=${COMPRESS_PROGRAM:Q} \
243		-f ${SETS_DIR}/${set}.${TAR_SUFF} .)
244.endfor
245.if defined(SECONDARY_BOOT)
246	@echo Copying secondary boot...
247	${INSTALL} ${COPY} -m 0644 ${WORKDIR}/usr/mdec/${SECONDARY_BOOT} ${WORKDIR}
248.endif
249	@echo Preparing /etc/fstab ...
250	${TOOL_SED} "s/@@BOOTDISK@@/${BOOTDISK}/" < ${FSTAB_IN} > ${WORKFSTAB}
251	${INSTALL} ${COPY} -m 0644 ${WORKFSTAB} ${WORKDIR}/etc/fstab
252	@echo Setting rc_configured=YES in /etc/rc.conf ...
253	${TOOL_SED} "s/rc_configured=NO/rc_configured=YES/"		\
254	    < ${WORKDIR}/etc/rc.conf > ${WORKRCCONF}
255	${INSTALL} ${COPY} -m 0644 ${WORKRCCONF} ${WORKDIR}/etc/rc.conf
256.if defined(IMGDIR_EXTRA)
257	@echo Copying extra dirs...
258.for _SRCDIR _TARGET in ${IMGDIR_EXTRA}
259	@if [ ! -d ${_SRCDIR} ]; then 					\
260		echo "${_SRCDIR} is not directory, aborting";		\
261		false; 							\
262	fi
263	${MKDIR} ${MKDIRPERM} ${WORKDIR}/${_TARGET}
264	(cd ${_SRCDIR} ;						\
265	    ${TOOL_PAX} -rw -pe	-v ${PAX_TIMESTAMP}			\
266	    ${IMGDIR_EXCLUDE}						\
267	    . ${.OBJDIR}/${WORKDIR}/${_TARGET} )
268.endfor
269.endif
270.if defined(IMGFILE_EXTRA)
271	@echo Copying extra files...
272.for _SRC _TARGET in ${IMGFILE_EXTRA}
273	@if [ ! -f ${_SRC} ]; then 					\
274		echo "${_SRC} in IMGFILE_EXTRA not found, aborting";	\
275		false; 							\
276	fi
277	@if [ -f ${_SRC} ]; then 					\
278		echo ${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET};		\
279		${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET};			\
280	fi
281.endfor
282.endif
283	@echo Preparing spec files for makefs...
284	${RM} -f ${WORKSPEC}
285	cat ${WORKDIR}/etc/mtree/* |					\
286	    ${TOOL_SED} -e 's/ size=[0-9]*//' > ${WORKSPEC}
287	${HOST_SH} ${WORKDIR}/dev/MAKEDEV -s all ipty |			\
288	    ${TOOL_SED} -e '/^\. type=dir/d' -e 's,^\.,./dev,' >> ${WORKSPEC}
289	cat ${SPEC_IN} >> ${WORKSPEC}
290.if defined(SECONDARY_BOOT)
291	echo "./${SECONDARY_BOOT} type=file uname=root gname=wheel mode=0444" \
292	    >> ${WORKSPEC}
293.endif
294.if defined(SPEC_EXTRA)
295	cat ${SPEC_EXTRA} >> ${WORKSPEC}
296.endif
297	@echo Creating rootfs...
298	# XXX /var/spool/ftp/hidden is unreadable
299	${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden
300	${TOOL_MAKEFS} -M ${FSSIZE} -m ${FSSIZE}			\
301	    -B ${TARGET_ENDIANNESS}					\
302	    -F ${WORKSPEC} -N ${WORKDIR}/etc				\
303	    ${MAKEFS_TIMESTAMP}						\
304	    ${IMGMAKEFSOPTIONS}						\
305	    ${WORKFS} ${WORKDIR}
306.if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} == "no"
307	${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKFS} \
308	    ${WORKDIR}/usr/mdec/${PRIMARY_BOOT} ${SECONDARY_BOOT_ARG}
309.endif
310	@echo done.
311	mv ${WORKFS} ${.TARGET}
312
313#
314# definitions to create image
315#
316.if ${USE_MBR} != "no"
317DISKPROTO_IN?=	${DISTRIBDIR}/common/bootimage/diskproto.mbr.in
318.else
319DISKPROTO_IN?=	${DISTRIBDIR}/common/bootimage/diskproto.in
320.endif
321
322MBR_DEFAULT_BOOTCODE?=	mbr
323
324OMIT_SWAPIMG?=	no
325
326WORKMBR?=	work.mbr
327WORKSWAP?=	work.swap
328WORKLABEL?=	work.diskproto
329WORKIMG?=	work.img
330
331CLEANFILES+=	${WORKMBR} ${WORKSWAP}
332CLEANFILES+=	${WORKLABEL}.tmp ${WORKLABEL}
333CLEANFILES+=	${WORKIMG} ${IMGBASE}.img
334
335${WORKLABEL}:
336	${TOOL_SED}							\
337	    -e "s/@@SECTORS@@/${SECTORS}/"				\
338	    -e "s/@@HEADS@@/${HEADS}/"					\
339	    -e "s/@@SECPERCYLINDERS@@/${SECPERCYLINDERS}/"		\
340	    -e "s/@@CYLINDERS@@/${CYLINDERS}/"				\
341	    -e "s/@@IMAGESECTORS@@/${IMAGESECTORS}/"			\
342	    -e "s/@@FSSECTORS@@/${FSSECTORS}/"				\
343	    -e "s/@@FSOFFSET@@/${FSOFFSET}/"				\
344	    -e "s/@@SWAPSECTORS@@/${SWAPSECTORS}/"			\
345	    -e "s/@@SWAPOFFSET@@/${SWAPOFFSET}/"			\
346	    -e "s/@@BSDPARTSECTORS@@/${BSDPARTSECTORS}/"		\
347	    < ${DISKPROTO_IN} > ${WORKLABEL}.tmp
348	mv ${WORKLABEL}.tmp ${WORKLABEL}
349
350${IMGBASE}.img:	${TARGETFS} ${WORKLABEL}
351.if ${USE_MBR} != "no"
352	@echo creating MBR labels...
353	${DD} if=/dev/zero of=${WORKMBR} seek=$$((${IMAGESECTORS} - 1)) count=1
354	${TOOL_FDISK} -f -i -u \
355	    -b ${MBRCYLINDERS}/${MBRHEADS}/${MBRSECTORS}		\
356	    -0 -a -s ${MBRNETBSD}/${FSOFFSET}/${BSDPARTSECTORS}		\
357	    -F ${WORKMBR}
358.if empty(MBR_BOOTCODE)
359	@if [ -f ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE} ]; then 	\
360		echo ${TOOL_FDISK} -f					\
361		    -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE}	\
362		    -F ${WORKMBR};					\
363		${TOOL_FDISK} -f					\
364		    -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE}	\
365		    -F ${WORKMBR};					\
366	fi
367.else
368	@if [ ! -f ${WORKDIR}/usr/mdec/${MBR_BOOTCODE} ]; then 		\
369		echo "${MBR_BOOTCODE} is not found in DESTDIR/usr/mdec, aborting"; \
370		false; 							\
371	fi
372	${TOOL_FDISK} -f -i -c ${WORKDIR}/usr/mdec/${MBR_BOOTCODE}	\
373	    -F ${WORKMBR}
374.endif
375	${DD} if=${WORKMBR} count=${LABELSECTORS} |			\
376	    ${CAT} - ${TARGETFS} > ${WORKIMG}
377.else
378	${INSTALL} ${COPY} -m 0644 ${TARGETFS} ${WORKIMG}
379.endif
380.if ${OMIT_SWAPIMG} == "no"
381	${DD} if=/dev/zero of=${WORKSWAP} seek=$$((${SWAPSECTORS} - 1)) count=1
382	${CAT} ${WORKSWAP} >> ${WORKIMG}
383.endif
384.if ${USE_SUNLABEL} != "no"
385	@echo Creating sun disklabel...
386	printf 'V ncyl %d\nV nhead %d\nV nsect %d\na %d %d/0/0\nb %d %d/0/0\nW\n' \
387	    ${CYLINDERS} ${HEADS} ${SECTORS} \
388	    ${FSOFFSET} ${FSCYLINDERS} ${FSCYLINDERS} ${SWAPCYLINDERS} | \
389	    ${TOOL_SUNLABEL} -nq ${WORKIMG}
390.endif
391	${TOOL_DISKLABEL} -R -F ${WORKIMG} ${WORKLABEL}
392.if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} != "no"
393	${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKIMG} \
394	    ${WORKDIR}/usr/mdec/${PRIMARY_BOOT}
395.endif
396	mv ${WORKIMG} ${.TARGET}
397
398
399CLEANFILES+=	${IMGBASE}.img.gz ${IMGBASE}.img.gz.tmp
400
401${IMGBASE}.img.gz:	${IMGBASE}.img
402	${TOOL_GZIP_N} -9c ${IMGBASE}.img > ${.TARGET}.tmp
403	mv ${.TARGET}.tmp ${.TARGET}
404
405clean:
406	@if [ -d ${WORKDIR}/var/spool/ftp/hidden ]; then 		\
407		${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden;		\
408	fi	# XXX
409	${RM} -fr ${WORKDIR}
410
411prepare_md_post: .PHONY
412image_md_post: .PHONY
413image_md_pre: .PHONY
414
415.include <bsd.prog.mk>
416