aboutsummaryrefslogtreecommitdiff
path: root/release/scripts/mk-vmimage.sh
blob: 8e79e2998a51f470324d0eb6429688ca746700f8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
#!/bin/sh
#-
# Copyright (c) 2014 The FreeBSD Foundation
# All rights reserved.
#
# This software was developed by Glen Barber under sponsorship
# from the FreeBSD Foundation.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# mk-vmimage.sh: Create virtual machine disk images in various formats.
#
# $FreeBSD$
#

PATH="/bin:/usr/bin:/sbin:/usr/sbin"
export PATH

usage() {
	echo "$(basename ${0}) <command> <target> [...]"
	if [ -z "${MAKEFLAGS}" ]; then
		echo "It is probably not safe to run this by hand yet..."
	fi
	exit 1
}

panic() {
	rc="${1}"
	shift 1
	msg="${@}"
	printf "${msg}\n"
	if [ ! -z "${mddev}" ]; then
		mdconfig -d -u ${mddev}
	fi
	# Do not allow one failure case to chain through any remaining image
	# builds.
	exit 0
}

vm_create_baseimage() {
	# Creates the UFS root filesystem for the virtual machine disk,
	# written to the formatted disk image with mkimg(1).
	i=0
	mkdir -p ${DESTDIR}
	truncate -s ${VMSIZE} ${VMBASE}
	mddev=$(mdconfig -f ${VMBASE})
	newfs -L rootfs -j /dev/${mddev}
	mount /dev/${mddev} ${DESTDIR}
	cd ${WORLDDIR} && \
		${IMAKE} DESTDIR=${DESTDIR} \
		installworld installkernel distribution || \
		panic 1 "\n\nCannot install the base system to ${DESTDIR}."
	chroot ${DESTDIR} /usr/bin/newaliases
	echo '# Custom /etc/fstab for FreeBSD VM images' \
		# > ${DESTDIR}/etc/fstab
	echo '/dev/gpt/rootfs	/	ufs	rw	2	2' \
		# >> ${DESTDIR}/etc/fstab
	echo '/dev/gpt/swapfs	none	swap	sw	0	0' \
		# >> ${DESTDIR}/etc/fstab
	sync
	while ! umount ${DESTDIR}; do
		i=$(( $i + 1 ))
		if [ $i -ge 10 ]; then
			# This should never happen.  But, it has happened.
			msg="Cannot umount(8) ${DESTDIR}\n"
			msg="${msg}Something has gone horribly wrong."
			panic 1 "${msg}"
		fi
		sleep 1
	done

	return 0
}

vm_create_vmdisk() {
	mkimg_version=$(mkimg --version 2>/dev/null | awk '{print $2}')

	# We need mkimg(1) '--version' output, at minimum, to be able to
	# tell what virtual machine disk image formats are available.
	# Bail if mkimg(1) reports an empty '--version' value.
	if [ -z "${mkimg_version}" ]; then
		msg="Cannot determine mkimg(1) version.\n"
		msg="${msg}Cannot continue without a known mkimg(1) version."
		panic 0 "${msg}"
	fi

	if ! mkimg --formats 2>/dev/null | grep -q ${FORMAT}; then
		panic 0 "Format ${FORMAT} is not supported with this mkimg(1)\n"
	fi

	case ${FORMAT} in
		vhd)
			mkimg_format=vhdf
			;;
		*)
			mkimg_format=${FORMAT}
			;;
	esac

	mkimg -f ${mkimg_format} -s gpt \
		-b /boot/pmbr -p freebsd-boot/bootfs:=/boot/gptboot \
		-p freebsd-swap/swapfs::1G \
		-p freebsd-ufs/rootfs:=${VMBASE} \
		-o ${VMIMAGE}

	return 0
}

main() {
	cmd="${1}"

	case ${TARGET}/${TARGET_ARCH} in
		amd64/amd64|i386/i386)
			# FALLTHROUGH
			;;
		*)
			# EX_CANTCREAT
			return 0
			;;
	esac

	case ${cmd} in
		vm-base)
			eval vm_create_baseimage "$@" || return 0
			;;
		vm-image)
			eval vm_create_vmdisk "$@" || return 0
			;;
		*|\?)
			usage
			;;
	esac

	return 0
}

main "$@"