Makefile.bootimage revision 1.14 1 # $NetBSD: Makefile.bootimage,v 1.14 2017/02/10 16:43:59 christos 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"
131 MAKEFS_TIMESTAMP=-T "${MKREPRO_TIMESTAMP}"
132 .endif
133
134 .if empty(IMGBASE)
135 .BEGIN:
136 @echo "Error: IMGBASE is not set"
137 @false
138 .endif
139
140 # should be defined elsewhere?
141 CAT?= cat
142 CHMOD?= chmod
143 DD?= dd
144 MKDIR?= mkdir -p
145 RM?= rm
146
147 #
148 # common definitions for image
149 #
150 BOOTDISK?= sd0
151 USE_MBR?= no
152 USE_SUNLABEL?= no
153 INSTALLBOOT_AFTER_DISKLABEL?= no
154
155 #
156 # size parameters for image
157 #
158 IMAGEMB?= 2048 # 2048MB
159 SWAPMB?= 128 # 128MB
160
161 # XXX: SWAPMB could be zero and expr(1) returns exit status 1 in that case
162 IMAGESECTORS!= expr ${IMAGEMB} \* 1024 \* 1024 / 512
163 SWAPSECTORS!= expr ${SWAPMB} \* 1024 \* 1024 / 512 || true
164
165 .if ${USE_MBR} == "no"
166 LABELSECTORS?= 0
167 .else
168 #LABELSECTORS?= 63 # historical
169 #LABELSECTORS?= 32 # 16KB aligned
170 LABELSECTORS?= 2048 # 1MB aligned for modern flash devices
171 .endif
172
173 FSSECTORS!= expr ${IMAGESECTORS} - ${SWAPSECTORS} - ${LABELSECTORS}
174 FSSIZE!= expr ${FSSECTORS} \* 512
175
176 # parameters for disklabel and MBR
177 HEADS= 64
178 SECTORS= 32
179 CYLINDERS!= expr ${IMAGESECTORS} / \( ${HEADS} \* ${SECTORS} \)
180 SECPERCYLINDERS!= expr ${HEADS} \* ${SECTORS}
181 MBRHEADS= 255
182 MBRSECTORS= 63
183 MBRCYLINDERS!= expr ${IMAGESECTORS} / \( ${MBRHEADS} \* ${MBRSECTORS} \)
184 MBRNETBSD= 169
185
186 BSDPARTSECTORS!= expr ${IMAGESECTORS} - ${LABELSECTORS}
187 FSOFFSET= ${LABELSECTORS}
188 SWAPOFFSET!= expr ${LABELSECTORS} + ${FSSECTORS}
189
190 # parameters for sunlabel
191 FSCYLINDERS!= expr ${FSSECTORS} / \( ${HEADS} \* ${SECTORS} \)
192 SWAPCYLINDERS!= expr ${SWAPSECTORS} / \( ${HEADS} \* ${SECTORS} \) || true
193
194
195 #
196 # definitions to create root fs
197 #
198 SETS_DEFAULT= modules base etc comp games man misc tests text
199 .if ${MKX11} != "no"
200 SETS_DEFAULT+= xbase xcomp xetc xfont xserver
201 .endif
202
203 KERN_SET?= kern-GENERIC
204 SETS?= ${SETS_DEFAULT}
205 IMG_SETS= ${KERN_SET} ${SETS}
206 SETS_DIR?= ${RELEASEDIR}/${RELEASEMACHINEDIR}/binary/sets
207
208 FSTAB_IN?= ${DISTRIBDIR}/common/bootimage/fstab.in
209 SPEC_IN?= ${DISTRIBDIR}/common/bootimage/spec.in
210
211 IMGMAKEFSOPTIONS?= -o bsize=16384,fsize=2048,density=8192
212
213 WORKDIR?= work
214 WORKSPEC?= work.spec
215 WORKFSTAB?= work.fstab
216 WORKRCCONF?= work.rc.conf
217 WORKFS?= work.rootfs
218 TARGETFS?= imgroot.fs
219
220 CLEANFILES+= ${WORKSPEC} ${WORKFSTAB} ${WORKRCCONF} ${WORKFS}
221 CLEANFILES+= ${TARGETFS}
222
223 #
224 # create root file system for the image
225 #
226 ${TARGETFS}: prepare_md_post
227 @if [ ! -d ${RELEASEDIR}/${RELEASEMACHINEDIR} ]; then \
228 echo "Missing ${RELEASEDIR}/${RELEASEMACHINEDIR}, aborting"; \
229 false; \
230 fi;
231 @${MKDIR} ${MKDIRPERM} ${WORKDIR}
232 .for set in ${IMG_SETS}
233 @if [ ! -f ${SETS_DIR}/${set}.tgz ]; then \
234 echo "Missing ${SETS_DIR}/${set}.tgz, aborting"; \
235 false; \
236 fi
237 @echo Extracting ${set}.tgz ...
238 @(cd ${WORKDIR}; ${TOOL_PAX} -rnz -f ${SETS_DIR}/${set}.tgz .)
239 .endfor
240 .if defined(SECONDARY_BOOT)
241 @echo Copying secondary boot...
242 ${INSTALL} ${COPY} -m 0644 -f ${WORKDIR}/usr/mdec/${SECONDARY_BOOT} ${WORKDIR}
243 .endif
244 @echo Preparing /etc/fstab ...
245 ${TOOL_SED} "s/@@BOOTDISK@@/${BOOTDISK}/" < ${FSTAB_IN} > ${WORKFSTAB}
246 ${INSTALL} ${COPY} -m 0644 ${WORKFSTAB} ${WORKDIR}/etc/fstab
247 @echo Setting rc_configured=YES in /etc/rc.conf ...
248 ${TOOL_SED} "s/rc_configured=NO/rc_configured=YES/" \
249 < ${WORKDIR}/etc/rc.conf > ${WORKRCCONF}
250 ${INSTALL} ${COPY} -m 0644 ${WORKRCCONF} ${WORKDIR}/etc/rc.conf
251 .if defined(IMGDIR_EXTRA)
252 @echo Copying extra dirs...
253 .for _SRCDIR _TARGET in ${IMGDIR_EXTRA}
254 @if [ ! -d ${_SRCDIR} ]; then \
255 echo "${_SRCDIR} is not directory, aborting"; \
256 false; \
257 fi
258 ${MKDIR} ${MKDIRPERM} ${WORKDIR}/${_TARGET}
259 (cd ${_SRCDIR} ; \
260 ${TOOL_PAX} -rw -pe -v \
261 ${IMGDIR_EXCLUDE} \
262 . ${.OBJDIR}/${WORKDIR}/${_TARGET} )
263 .endfor
264 .endif
265 .if defined(IMGFILE_EXTRA)
266 @echo Copying extra files...
267 .for _SRC _TARGET in ${IMGFILE_EXTRA}
268 @if [ ! -f ${_SRC} ]; then \
269 echo "${_SRC} in IMGFILE_EXTRA not found, aborting"; \
270 false; \
271 fi
272 @if [ -f ${_SRC} ]; then \
273 echo ${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET}; \
274 ${INSTALL} ${COPY} -m 0644 ${_SRC} ${WORKDIR}/${_TARGET}; \
275 fi
276 .endfor
277 .endif
278 @echo Preparing spec files for makefs...
279 ${RM} -f ${WORKSPEC}
280 cat ${WORKDIR}/etc/mtree/* | \
281 ${TOOL_SED} -e 's/ size=[0-9]*//' > ${WORKSPEC}
282 ${HOST_SH} ${WORKDIR}/dev/MAKEDEV -s all ipty | \
283 ${TOOL_SED} -e '/^\. type=dir/d' -e 's,^\.,./dev,' >> ${WORKSPEC}
284 cat ${SPEC_IN} >> ${WORKSPEC}
285 .if defined(SECONDARY_BOOT)
286 echo "./${SECONDARY_BOOT} type=file uname=root gname=wheel mode=0444" \
287 >> ${WORKSPEC}
288 .endif
289 .if defined(SPEC_EXTRA)
290 cat ${SPEC_EXTRA} >> ${WORKSPEC}
291 .endif
292 @echo Creating rootfs...
293 # XXX /var/spool/ftp/hidden is unreadable
294 ${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden
295 ${TOOL_MAKEFS} -M ${FSSIZE} -m ${FSSIZE} \
296 -B ${TARGET_ENDIANNESS} \
297 -F ${WORKSPEC} -N ${WORKDIR}/etc \
298 ${MAKEFS_TIMESTAMP} \
299 ${IMGMAKEFSOPTIONS} \
300 ${WORKFS} ${WORKDIR}
301 .if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} == "no"
302 ${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKFS} \
303 ${WORKDIR}/usr/mdec/${PRIMARY_BOOT} ${SECONDARY_BOOT_ARG}
304 .endif
305 @echo done.
306 mv ${WORKFS} ${.TARGET}
307
308 #
309 # definitions to create image
310 #
311 .if ${USE_MBR} != "no"
312 DISKPROTO_IN?= ${DISTRIBDIR}/common/bootimage/diskproto.mbr.in
313 .else
314 DISKPROTO_IN?= ${DISTRIBDIR}/common/bootimage/diskproto.in
315 .endif
316
317 MBR_DEFAULT_BOOTCODE?= mbr
318
319 OMIT_SWAPIMG?= no
320
321 WORKMBR?= work.mbr
322 WORKSWAP?= work.swap
323 WORKLABEL?= work.diskproto
324 WORKIMG?= work.img
325
326 CLEANFILES+= ${WORKMBR} ${WORKSWAP}
327 CLEANFILES+= ${WORKLABEL}.tmp ${WORKLABEL}
328 CLEANFILES+= ${WORKIMG} ${IMGBASE}.img
329
330 ${WORKLABEL}:
331 ${TOOL_SED} \
332 -e "s/@@SECTORS@@/${SECTORS}/" \
333 -e "s/@@HEADS@@/${HEADS}/" \
334 -e "s/@@SECPERCYLINDERS@@/${SECPERCYLINDERS}/" \
335 -e "s/@@CYLINDERS@@/${CYLINDERS}/" \
336 -e "s/@@IMAGESECTORS@@/${IMAGESECTORS}/" \
337 -e "s/@@FSSECTORS@@/${FSSECTORS}/" \
338 -e "s/@@FSOFFSET@@/${FSOFFSET}/" \
339 -e "s/@@SWAPSECTORS@@/${SWAPSECTORS}/" \
340 -e "s/@@SWAPOFFSET@@/${SWAPOFFSET}/" \
341 -e "s/@@BSDPARTSECTORS@@/${BSDPARTSECTORS}/" \
342 < ${DISKPROTO_IN} > ${WORKLABEL}.tmp
343 mv ${WORKLABEL}.tmp ${WORKLABEL}
344
345 ${IMGBASE}.img: ${TARGETFS} ${WORKLABEL}
346 .if ${USE_MBR} != "no"
347 @echo creating MBR labels...
348 ${DD} if=/dev/zero of=${WORKMBR} seek=$$((${IMAGESECTORS} - 1)) count=1
349 ${TOOL_FDISK} -f -i -u \
350 -b ${MBRCYLINDERS}/${MBRHEADS}/${MBRSECTORS} \
351 -0 -a -s ${MBRNETBSD}/${FSOFFSET}/${BSDPARTSECTORS} \
352 -F ${WORKMBR}
353 .if empty(MBR_BOOTCODE)
354 @if [ -f ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE} ]; then \
355 echo ${TOOL_FDISK} -f \
356 -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE} \
357 -F ${WORKMBR}; \
358 ${TOOL_FDISK} -f \
359 -i -c ${WORKDIR}/usr/mdec/${MBR_DEFAULT_BOOTCODE} \
360 -F ${WORKMBR}; \
361 fi
362 .else
363 @if [ ! -f ${WORKDIR}/usr/mdec/${MBR_BOOTCODE} ]; then \
364 echo "${MBR_BOOTCODE} is not found in DESTDIR/usr/mdec, aborting"; \
365 false; \
366 fi
367 ${TOOL_FDISK} -f -i -c ${WORKDIR}/usr/mdec/${MBR_BOOTCODE} \
368 -F ${WORKMBR}
369 .endif
370 ${DD} if=${WORKMBR} count=${LABELSECTORS} | \
371 ${CAT} - ${TARGETFS} > ${WORKIMG}
372 .else
373 ${INSTALL} ${COPY} -m 0644 ${TARGETFS} ${WORKIMG}
374 .endif
375 .if ${OMIT_SWAPIMG} == "no"
376 ${DD} if=/dev/zero of=${WORKSWAP} seek=$$((${SWAPSECTORS} - 1)) count=1
377 ${CAT} ${WORKSWAP} >> ${WORKIMG}
378 .endif
379 .if ${USE_SUNLABEL} != "no"
380 @echo Creating sun disklabel...
381 printf 'V ncyl %d\nV nhead %d\nV nsect %d\na %d %d/0/0\nb %d %d/0/0\nW\n' \
382 ${CYLINDERS} ${HEADS} ${SECTORS} \
383 ${FSOFFSET} ${FSCYLINDERS} ${FSCYLINDERS} ${SWAPCYLINDERS} | \
384 ${TOOL_SUNLABEL} -nq ${WORKIMG}
385 .endif
386 ${TOOL_DISKLABEL} -R -F ${WORKIMG} ${WORKLABEL}
387 .if !empty(PRIMARY_BOOT) && ${INSTALLBOOT_AFTER_DISKLABEL} != "no"
388 ${TOOL_INSTALLBOOT} -v -m ${MACHINE} ${INSTALLBOOTOPTIONS} ${WORKIMG} \
389 ${WORKDIR}/usr/mdec/${PRIMARY_BOOT}
390 .endif
391 mv ${WORKIMG} ${.TARGET}
392
393
394 CLEANFILES+= ${IMGBASE}.img.gz ${IMGBASE}.img.gz.tmp
395
396 ${IMGBASE}.img.gz: ${IMGBASE}.img
397 ${TOOL_GZIP_N} -9c ${IMGBASE}.img > ${.TARGET}.tmp
398 mv ${.TARGET}.tmp ${.TARGET}
399
400 clean:
401 @if [ -d ${WORKDIR}/var/spool/ftp/hidden ]; then \
402 ${CHMOD} +r ${WORKDIR}/var/spool/ftp/hidden; \
403 fi # XXX
404 ${RM} -fr ${WORKDIR}
405
406 prepare_md_post: .PHONY
407 image_md_post: .PHONY
408 image_md_pre: .PHONY
409
410 .include <bsd.prog.mk>
411