vmimage.subr revision 329145 
1#!/bin/sh
2#
3# $FreeBSD: stable/11/release/tools/vmimage.subr 329145 2018-02-12 01:08:44Z kevans $
4#
5#
6# Common functions for virtual machine image build scripts.
7#
8
9export PATH="/bin:/usr/bin:/sbin:/usr/sbin:/usr/local/bin:/usr/local/sbin"
10trap "cleanup" INT QUIT TRAP ABRT TERM
11
12write_partition_layout() {
13	if [ -z "${NOSWAP}" ]; then
14		SWAPOPT="-p freebsd-swap/swapfs::${SWAPSIZE}"
15	fi
16
17	_OBJDIR="$(make -C ${WORLDDIR} -V .OBJDIR)"
18	_OBJDIR="$(realpath ${_OBJDIR})"
19	if [ -d "${_OBJDIR%%/usr/src}/${TARGET}.${TARGET_ARCH}" ]; then
20		BOOTFILES="/${_OBJDIR%%/usr/src}/${TARGET}.${TARGET_ARCH}/usr/src/stand"
21	else
22		BOOTFILES="/${_OBJDIR}/stand"
23	fi
24
25	case "${TARGET}:${TARGET_ARCH}" in
26		amd64:amd64 | i386:i386)
27			mkimg -s gpt -f ${VMFORMAT} \
28				-b ${BOOTFILES}/i386/pmbr/pmbr \
29				-p freebsd-boot/bootfs:=${BOOTFILES}/i386/gptboot/gptboot \
30				${SWAPOPT} \
31				-p freebsd-ufs/rootfs:=${VMBASE} \
32				-o ${VMIMAGE}
33			;;
34		arm64:aarch64)
35			mkimg -s mbr -f ${VMFORMAT} \
36				-p efi:=${BOOTFILES}/efi/boot1/boot1.efifat \
37				-p freebsd:=${VMBASE} \
38				-o ${VMIMAGE}
39			;;
40		powerpc:powerpc*)
41			mkimg -s apm -f ${VMFORMAT} \
42				-p apple-boot/bootfs:=${BOOTFILES}/powerpc/boot1.chrp/boot1.hfs \
43				${SWAPOPT} \
44				-p freebsd-ufs/rootfs:=${VMBASE} \
45				-o ${VMIMAGE}
46			;;
47		*)
48			# ENOTSUPP
49			return 1
50			;;
51	esac
52
53	return 0
54}
55
56err() {
57	printf "${@}\n"
58	cleanup
59	return 1
60}
61
62cleanup() {
63	if [ -c "${DESTDIR}/dev/null" ]; then
64		umount_loop ${DESTDIR}/dev 2>/dev/null
65	fi
66	umount_loop ${DESTDIR}
67	if [ ! -z "${mddev}" ]; then
68		mdconfig -d -u ${mddev}
69	fi
70
71	return 0
72}
73
74vm_create_base() {
75	# Creates the UFS root filesystem for the virtual machine disk,
76	# written to the formatted disk image with mkimg(1).
77
78	mkdir -p ${DESTDIR}
79	truncate -s ${VMSIZE} ${VMBASE}
80	mddev=$(mdconfig -f ${VMBASE})
81	newfs -L rootfs /dev/${mddev}
82	mount /dev/${mddev} ${DESTDIR}
83
84	return 0
85}
86
87vm_copy_base() {
88	# Creates a new UFS root filesystem and copies the contents of the
89	# current root filesystem into it.  This produces a "clean" disk
90	# image without any remnants of files which were created temporarily
91	# during image-creation and have since been deleted (e.g., downloaded
92	# package archives).
93
94	mkdir -p ${DESTDIR}/old
95	mdold=$(mdconfig -f ${VMBASE})
96	mount /dev/${mdold} ${DESTDIR}/old
97
98	truncate -s ${VMSIZE} ${VMBASE}.tmp
99	mkdir -p ${DESTDIR}/new
100	mdnew=$(mdconfig -f ${VMBASE}.tmp)
101	newfs -L rootfs /dev/${mdnew}
102	mount /dev/${mdnew} ${DESTDIR}/new
103
104	tar -cf- -C ${DESTDIR}/old . | tar -xUf- -C ${DESTDIR}/new
105
106	umount_loop /dev/${mdold}
107	rmdir ${DESTDIR}/old
108	mdconfig -d -u ${mdold}
109
110	umount_loop /dev/${mdnew}
111	rmdir ${DESTDIR}/new
112	tunefs -n enable /dev/${mdnew}
113	mdconfig -d -u ${mdnew}
114	mv ${VMBASE}.tmp ${VMBASE}
115}
116
117vm_install_base() {
118	# Installs the FreeBSD userland/kernel to the virtual machine disk.
119
120	cd ${WORLDDIR} && \
121		make DESTDIR=${DESTDIR} \
122		installworld installkernel distribution || \
123		err "\n\nCannot install the base system to ${DESTDIR}."
124
125	# Bootstrap etcupdate(8) and mergemaster(8) databases.
126	mkdir -p ${DESTDIR}/var/db/etcupdate
127	etcupdate extract -B \
128		-M "TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}" \
129		-s ${WORLDDIR} -d ${DESTDIR}/var/db/etcupdate
130	sh ${WORLDDIR}/release/scripts/mm-mtree.sh -m ${WORLDDIR} \
131		-F "TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}" \
132		-D ${DESTDIR}
133
134	echo '# Custom /etc/fstab for FreeBSD VM images' \
135		> ${DESTDIR}/etc/fstab
136	echo "/dev/${ROOTLABEL}/rootfs   /       ufs     rw      1       1" \
137		>> ${DESTDIR}/etc/fstab
138	if [ -z "${NOSWAP}" ]; then
139		echo '/dev/gpt/swapfs  none    swap    sw      0       0' \
140			>> ${DESTDIR}/etc/fstab
141	fi
142
143	local hostname
144	hostname="$(echo $(uname -o) | tr '[:upper:]' '[:lower:]')"
145	echo "hostname=\"${hostname}\"" >> ${DESTDIR}/etc/rc.conf
146
147	mkdir -p ${DESTDIR}/dev
148	mount -t devfs devfs ${DESTDIR}/dev
149	chroot ${DESTDIR} /usr/bin/newaliases
150	chroot ${DESTDIR} /etc/rc.d/ldconfig forcestart
151	umount_loop ${DESTDIR}/dev
152
153	cp /etc/resolv.conf ${DESTDIR}/etc/resolv.conf
154
155	return 0
156}
157
158vm_extra_install_base() {
159	# Prototype.  When overridden, runs extra post-installworld commands
160	# as needed, based on the target virtual machine image or cloud
161	# provider image target.
162
163	return 0
164}
165
166vm_extra_enable_services() {
167	if [ ! -z "${VM_RC_LIST}" ]; then
168		for _rcvar in ${VM_RC_LIST}; do
169			echo ${_rcvar}_enable="YES" >> ${DESTDIR}/etc/rc.conf
170		done
171	fi
172
173	if [ -z "${VMCONFIG}" -o -c "${VMCONFIG}" ]; then
174		echo 'ifconfig_DEFAULT="DHCP inet6 accept_rtadv"' >> \
175			${DESTDIR}/etc/rc.conf
176	fi
177
178	return 0
179}
180
181vm_extra_install_packages() {
182	if [ -z "${VM_EXTRA_PACKAGES}" ]; then
183		return 0
184	fi
185	mkdir -p ${DESTDIR}/dev
186	mount -t devfs devfs ${DESTDIR}/dev
187	chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
188		/usr/sbin/pkg bootstrap -y
189	chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
190		/usr/sbin/pkg install -y ${VM_EXTRA_PACKAGES}
191	umount_loop ${DESTDIR}/dev
192
193	return 0
194}
195
196vm_extra_install_ports() {
197	# Prototype.  When overridden, installs additional ports within the
198	# virtual machine environment.
199
200	return 0
201}
202
203vm_extra_pre_umount() {
204	# Prototype.  When overridden, performs additional tasks within the
205	# virtual machine environment prior to unmounting the filesystem.
206	# Note: When overriding this function, removing resolv.conf in the
207	# disk image must be included.
208
209	rm -f ${DESTDIR}/etc/resolv.conf
210	return 0
211}
212
213vm_extra_pkg_rmcache() {
214	if [ -e ${DESTDIR}/usr/local/sbin/pkg ]; then
215		chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
216			/usr/local/sbin/pkg clean -y -a
217	fi
218
219	return 0
220}
221
222umount_loop() {
223	DIR=$1
224	i=0
225	sync
226	while ! umount ${DIR}; do
227		i=$(( $i + 1 ))
228		if [ $i -ge 10 ]; then
229			# This should never happen.  But, it has happened.
230			echo "Cannot umount(8) ${DIR}"
231			echo "Something has gone horribly wrong."
232			return 1
233		fi
234		sleep 1
235	done
236
237	return 0
238}
239
240vm_create_disk() {
241	echo "Creating image...  Please wait."
242	echo
243
244	write_partition_layout || return 1
245
246	return 0
247}
248
249vm_extra_create_disk() {
250
251	return 0
252}
253
254