mkimage revision 1.63
1#!/bin/sh
2# $NetBSD: mkimage,v 1.63 2017/04/11 18:04:08 jmcneill Exp $
3#
4# Copyright (c) 2013, 2014 The NetBSD Foundation, Inc.
5# All rights reserved.
6#
7# This code is derived from software contributed to The NetBSD Foundation
8# by Christos Zoulas.
9#
10# Redistribution and use in source and binary forms, with or without
11# modification, are permitted provided that the following conditions
12# are met:
13# 1. Redistributions of source code must retain the above copyright
14#    notice, this list of conditions and the following disclaimer.
15# 2. Redistributions in binary form must reproduce the above copyright
16#    notice, this list of conditions and the following disclaimer in the
17#    documentation and/or other materials provided with the distribution.
18# 3. Neither the name of The NetBSD Foundation nor the names of its
19#    contributors may be used to endorse or promote products derived
20#    from this software without specific prior written permission.
21#
22# THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32# POSSIBILITY OF SUCH DAMAGE.
33#
34
35#
36# Makes a bootable image for the host architecture given.
37# The host specific functions are pulled in from a /bin/sh script in the
38# "conf" directory, and is expected to provide the following shell
39# functions, which are called in the following order:
40#
41#  - make_fstab: Creates the host's /etc/fstab with / on ${rootdev}.
42#    If -m is given, a number of directories are put on a tmpfs RAM disk
43#  - customize: After unpacking the sets, this gets the system to
44#    a working state, e. g. by setting up /etc/rc.conf and /dev
45#  - populate: Add common goods like kernel and bootloader
46#  - make_label: Prints disklabel to stdout
47#
48
49set -e
50
51DIR="$(cd "$(dirname "$0")" && pwd)"
52PROG="$(basename "$0")"
53
54DISKLABEL=${TOOL_DISKLABEL:-disklabel}
55FDISK=${TOOL_FDISK:-fdisk}
56MAKEFS=${TOOL_MAKEFS:-makefs}
57MTREE=${TOOL_MTREE:-mtree}
58INSTALLBOOT=${TOOL_INSTALLBOOT:-installboot}
59MKUBOOTIMAGE=${TOOL_MKUBOOTIMAGE:-mkubootimage}
60GZIP_CMD=${TOOL_GZIP:-gzip} # ${GZIP} is special to gzip(1)
61
62src="/usr/src"
63sets="base comp etc games man misc modules text"
64xsets="xbase xcomp xetc xfont xserver" 
65minfree="10%"
66bar="==="
67
68tmp="$(mktemp -d "/tmp/$PROG.XXXXXX")"
69mnt="${tmp}/mnt"
70mkdir -p "${mnt}/etc" "${mnt}/dev"
71
72trap "cleanup" 0 1 2 3 15
73
74cleanup() {
75	case "$tmp" in
76	/tmp/$PROG.*)	rm -fr "$tmp";;
77	esac
78}
79
80getsize() {
81	set -- $(ls -l $1)
82	echo $5
83}
84
85getsectors() {
86	case "$1" in
87	*g)
88		m=1073741824
89		v=${1%g}
90		;;
91	*m)
92		m=1048576
93		v=${1%m}
94		;;
95	*k)
96		m=1024
97		v=${1%k}
98		;;
99	*[0-9b])
100		m=1
101		v=${1%b}
102		;;
103	esac
104	echo $((m * v / 512))
105}
106
107usage() {
108	cat << EOF 1>&2
109Usage: $PROG -h <host-arch> [-bdmx] [-B <byte-order>] [-K <kerneldir>] [-S <srcdir>] [-D <destdir>] [-c <custom-files-dir>] [-s <Mb size>] [<image>]
110
111-b	Boot only, no sets loaded
112-r	root device kind (sd, wd, ld)
113-d	Add the debug sets
114-m	Optimize the OS installation to mimimize disk writes for SSDs
115-x	Load the X sets too, not just the base ones
116EOF
117	exit 1
118}
119
120# First pass for options to get the host and src directories
121OPTS="B:D:K:S:bc:dh:mr:s:x"
122while getopts "$OPTS" f
123do
124	case $f in
125	h)	h="$OPTARG";;
126	S)	src="$OPTARG";;
127	*)	;;
128	esac
129done
130
131if [ -z "$h" ]
132then
133	usage
134fi
135
136if [ ! -f "${DIR}/conf/${h}.conf" ]
137then
138	echo $PROG: ${DIR}/conf/${h}.conf is not present 1>&2
139	exit 1
140fi
141
142resize=false
143
144. "${DIR}/conf/${h}.conf"
145release="/usr/obj/${MACHINE}/release"
146
147selected_sets="$sets"
148dsets_p=false
149xsets_p=false
150minwrites=false
151rootdev=ld
152endian=
153
154OPTIND=1
155while getopts "$OPTS" f
156do
157	case $f in
158	B)	endian="-B $OPTARG";;
159	D)	release="$OPTARG";;
160	K)	kernel="$OPTARG";;
161	S)	;;
162	b)	bootonly=true;;
163	d)	dsets_p=true
164		selected_sets="$selected_sets debug"
165		if $xsets_p; then
166			selected_sets="$selected_sets xdebug"
167		fi
168		;;
169	c)	custom="$OPTARG";;
170	h)	;;
171	m)	minwrites=true;;
172	r)	rootdev="$OPTARG";;
173	s)	size="$OPTARG";;
174	x)	xsets_p=true
175		selected_sets="$selected_sets $xsets"
176		if $dsets_p; then
177		    selected_sets="$selected_sets xdebug"
178		fi
179		;;
180	*)	usage;;
181	esac
182done
183
184shift $(( $OPTIND - 1 ))
185if [ -n "$1" ]; then
186	# take the next argument as being the image name
187	image="$1"
188	shift
189fi
190
191case "$image" in
192*.gz)	compress=true; image="${image%.gz}";;
193*)	compress=false;;
194esac
195
196if [ -z "${bootonly}" ]; then
197	echo ${bar} configuring sets ${bar}
198	(cat "${release}/etc/mtree/NetBSD.dist"
199	for i in $selected_sets; do
200		s="${release}/etc/mtree/set.$i"
201		if [ -f "$s" ]; then
202			cat "$s"
203		fi
204	done) > "$tmp/selected_sets"
205fi
206
207make_fstab
208customize
209populate
210
211if [ -n "${msdosid}" ]; then
212	echo ${bar} Populating msdos filesystem ${bar}
213	${MAKEFS} -N ${release}/etc -t msdos -o volume_label=NETBSD \
214	    -O $((${init} / 2))m -s $((${boot} / 2))m \
215	    ${image} ${mnt}/boot
216fi
217
218if [ -z "${bootonly}" ]; then
219	echo ${bar} Populating ffs filesystem ${bar}
220	${MAKEFS} -rx ${endian} -N ${release}/etc -t ffs \
221	    -O ${ffsoffset} \
222	    -o d=4096,f=8192,b=65536 -b $((${extra}))m \
223	    -F "$tmp/selected_sets" ${image} "${release}" "${mnt}"
224fi
225
226if [ "${size}" = 0 ]; then
227	size="$(getsize "${image}")"
228fi
229newsize=$((${size} / 2 / 1024))
230compare=$((${newsize} * 2 * 1024))
231while [ "${compare}" != "${size}" ]
232do    
233	size="$((size + size - compare))"  
234	newsize="$((${size} / 2 / 1024))"
235	compare="$((${newsize} * 2 * 1024))"
236done                      
237
238echo ${bar} Adding label ${bar}
239make_label > ${tmp}/label
240${DISKLABEL} -R -F ${image} ${tmp}/label
241if [ -n "${msdosid}" ]; then
242	echo ${bar} Running fdisk ${bar}
243	initsecs=$((${init} * 1024))
244	bootsecs=$((${boot} * 1024))
245	${FDISK} -f -i ${image}
246	${FDISK} -f -a -u -0 -s ${msdosid}/${initsecs}/${bootsecs} -F ${image}
247	if [ -z "${bootonly}" ]; then
248		ffsstart="$(getsectors ${ffsoffset})"
249		imagesize="$(getsize "${image}")"
250		imagesecs="$(getsectors ${imagesize})"
251		ffssize="$(expr ${imagesecs} - ${ffsstart})"
252		${FDISK} -f -u -1 -s 169/${ffsstart}/${ffssize} -F ${image}
253	fi
254elif [ -n "${netbsdid}" ]; then
255	echo ${bar} Running fdisk ${bar}
256	${FDISK} -f -i ${image}
257	${FDISK} -f -a -u -0 -s 169/${init} ${image}
258	${INSTALLBOOT} -f -v ${image} ${release}/usr/mdec/bootxx_ffsv1
259fi
260
261if $compress; then
262	echo ${bar} Compressing image ${bar}
263	rm -f "${image}.gz"
264	${GZIP_CMD} -9 ${image}
265	image="${image}.gz"
266fi
267
268echo ${bar} Image is ${image} ${bar}
269