Upgrade libressl. 1/2
[dragonfly.git] / initrd / mkinitrd.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2010, 2018
4 #       The DragonFly Project.  All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # 1. Redistributions of source code must retain the above copyright
11 #    notice, this list of conditions and the following disclaimer.
12 # 2. Redistributions in binary form must reproduce the above copyright
13 #    notice, this list of conditions and the following disclaimer in
14 #    the documentation and/or other materials provided with the
15 #    distribution.
16 # 3. Neither the name of The DragonFly Project nor the names of its
17 #    contributors may be used to endorse or promote products derived
18 #    from this software without specific, prior written permission.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24 # COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 # INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 # SUCH DAMAGE.
32 #
33
34 #
35 # Description
36 #
37 # This tool packs the (statically linked) rescue tools (at /rescue by
38 # default) and contents specified by "-c <content_dirs>", such as the
39 # necessary etc files, into an UFS-formatted VN image.  This image is
40 # installed at /boot/kernel/initrd.img.gz and used as the initial ramdisk
41 # to help mount the real root filesystem when it is encrypted or on LVM.
42 #
43
44
45 #
46 # Default configurations
47 #
48
49 # Directory hierarchy on the initrd
50 #
51 # * 'new_root' will always be created
52 # * 'sbin' will be symlinked to 'bin'
53 # * 'tmp' will be symlinked to 'var/tmp'
54 #
55 INITRD_DIRS="bin dev etc mnt var"
56
57 # Directory of the statically linked rescue tools which will be copied
58 # onto the initrd.
59 RESCUE_DIR="/rescue"
60
61 # Specify the location that the initrd will be installed to, i.e.,
62 # <BOOT_DIR>/kernel/initrd.img.gz
63 BOOT_DIR="/boot"
64
65 # Maximum size (number of MB) allowed for the initrd image
66 INITRD_SIZE_MAX="15"  # MB
67
68 # When run from the buildworld/installworld environment do not require that
69 # things like uniq, kldload, mount, newfs, etc be in the cross-tools.
70 # These must run natively for the current system version.
71 #
72 PATH=${PATH}:/sbin:/usr/sbin:/bin:/usr/bin
73
74 #
75 # Helper functions
76 #
77
78 log() {
79         echo "$@" >&2
80 }
81
82 error() {
83         local rc=$1
84         shift
85         log "$@"
86         exit ${rc}
87 }
88
89 check_dirs() {
90         for _dir; do
91                 [ -d "${_dir}" ] ||
92                     error 1 "Directory '${_dir}' does not exist"
93         done
94         return 0
95 }
96
97
98 #
99 # Functions
100 #
101
102 calc_initrd_size() {
103         log "Calculating required initrd size ..."
104         isize=0
105         for _dir; do
106                 csize=$(du -kst ${_dir} | awk '{ print $1 }')  # KB
107                 log "* ${_dir}: ${csize} KB"
108                 isize=$((${isize} + ${csize}))
109         done
110         # Round initrd size up by MB
111         isize_mb=$(echo ${isize} | awk '
112             function ceil(x) {
113                 y = int(x);
114                 return (x>y ? y+1 : y);
115             }
116             {
117                 print ceil($1 / 1024);
118             }')
119         # Reserve another 1 MB for advanced user to add custom files to the
120         # initrd without creating it from scratch.
121         echo $((${isize_mb} + 1))
122 }
123
124 create_vn() {
125         kldstat -qm vn || kldload -n vn ||
126             error 1 "Failed to load vn kernel module"
127
128         VN_DEV=$(vnconfig -c -S ${INITRD_SIZE}m -Z -T vn ${INITRD_FILE}) &&
129             echo "Configured ${VN_DEV}" ||
130             error 1 "Failed to configure VN device"
131
132         newfs -i 131072 -m 0 /dev/${VN_DEV}s0 &&
133             echo "Formatted initrd image with UFS" ||
134             error 1 "Failed to format the initrd image"
135         mount_ufs /dev/${VN_DEV}s0 ${BUILD_DIR} &&
136             echo "Mounted initrd image on ${BUILD_DIR}" ||
137             error 1 "Failed to mount initrd image on ${BUILD_DIR}"
138 }
139
140 destroy_vn() {
141         umount /dev/${VN_DEV}s0 &&
142             echo "Unmounted initrd image" ||
143             error 1 "Failed to umount initrd image"
144         vnconfig -u ${VN_DEV} &&
145             echo "Unconfigured ${VN_DEV}" ||
146             error 1 "Failed to unconfigure ${VN_DEV}"
147 }
148
149 make_hier() {
150         mkdir -p ${BUILD_DIR}/new_root ||
151             error 1 "Failed to mkdir ${BUILD_DIR}/new_root"
152         # Symlink 'sbin' to 'bin'
153         ln -sf bin ${BUILD_DIR}/sbin
154         # Symlink 'tmp' to 'var/tmp', as '/var' will be mounted with
155         # tmpfs, saving a second tmpfs been mounted on '/tmp'.
156         ln -sf var/tmp ${BUILD_DIR}/tmp
157         for _dir in ${INITRD_DIRS}; do
158                 [ ! -d "${BUILD_DIR}/${_dir}" ] &&
159                     mkdir -p ${BUILD_DIR}/${_dir}
160         done
161         echo "Created directory structure"
162 }
163
164 copy_rescue() {
165         cpdup -o -u ${RESCUE_DIR}/ ${BUILD_DIR}/bin/ &&
166             echo "Copied ${RESCUE_DIR} to ${BUILD_DIR}/bin" ||
167             error 1 "Failed to copy ${RESCUE_DIR} to ${BUILD_DIR}/bin"
168 }
169
170 copy_content() {
171         for _dir in ${CONTENT_DIRS}; do
172                 cpdup -o -u ${_dir}/ ${BUILD_DIR}/ &&
173                     echo "Copied ${_dir} to ${BUILD_DIR}" ||
174                     error 1 "Failed to copy ${dir} to ${BUILD_DIR}"
175         done
176 }
177
178 print_info() {
179         lt ${BUILD_DIR}
180         df -h ${BUILD_DIR}
181 }
182
183 # Check the validity of the created initrd image before moving over.
184 # This prevents creating an empty and broken initrd image by running
185 # this tool but without ${CONTENT_DIRS} prepared.
186 #
187 # NOTE: Need more improvements.
188 #
189 check_initrd()
190 {
191         [ -x "${BUILD_DIR}/sbin/oinit" ] &&
192         [ -x "${BUILD_DIR}/bin/sh" ] &&
193         [ -x "${BUILD_DIR}/etc/rc" ] || {
194                 destroy_vn
195                 error 1 "Ivalid initrd image!"
196         }
197 }
198
199 usage() {
200         error 2 \
201             "usage: ${0##*/} [-b boot_dir] [-r rescue_dir]" \
202             "[-s size] [-S max_size] -c <content_dirs>"
203 }
204
205
206 #
207 # Main
208 #
209
210 while getopts :b:c:hr:s:S: opt; do
211         case ${opt} in
212         b)
213                 BOOT_DIR="${OPTARG}"
214                 ;;
215         c)
216                 CONTENT_DIRS="${OPTARG}"
217                 ;;
218         h)
219                 usage
220                 ;;
221         r)
222                 RESCUE_DIR="${OPTARG}"
223                 ;;
224         s)
225                 INITRD_SIZE="${OPTARG}"
226                 ;;
227         S)
228                 INITRD_SIZE_MAX="${OPTARG}"
229                 ;;
230         \?)
231                 log "Invalid option -${OPTARG}"
232                 usage
233                 ;;
234         :)
235                 log "Option -${OPTARG} requires an argument"
236                 usage
237                 ;;
238         esac
239 done
240
241 shift $((OPTIND - 1))
242 [ $# -ne 0 ] && usage
243 [ -z "${BOOT_DIR}" -o -z "${RESCUE_DIR}" -o -z "${CONTENT_DIRS}" ] && usage
244 check_dirs ${BOOT_DIR} ${RESCUE_DIR} ${CONTENT_DIRS}
245
246 VN_DEV=""
247 INITRD_SIZE=${INITRD_SIZE%[mM]}  # MB
248 INITRD_SIZE_MAX=${INITRD_SIZE_MAX%[mM]}  # MB
249
250 BUILD_DIR=$(mktemp -d -t initrd) || error $? "Cannot create build directory"
251 echo "Initrd build directory: ${BUILD_DIR}"
252 INITRD_FILE="${BUILD_DIR}.img"
253 INITRD_DEST="${BOOT_DIR}/kernel/initrd.img.gz"
254
255 CSIZE=$(calc_initrd_size ${RESCUE_DIR} ${CONTENT_DIRS})
256 echo "Required initrd image size: ${CSIZE} MB"
257 if [ -n "${INITRD_SIZE}" -a "${INITRD_SIZE}" != "0" ]; then
258         if [ ${CSIZE} -gt ${INITRD_SIZE} ]; then
259                 error 1 "Given initrd size (${INITRD_SIZE} MB) too small"
260         fi
261 else
262         INITRD_SIZE=${CSIZE}
263 fi
264 echo "Initrd size: ${INITRD_SIZE} MB"
265
266 if [ -n "${INITRD_SIZE_MAX}" -a "${INITRD_SIZE_MAX}" != "0" ] && \
267    [ ${INITRD_SIZE} -gt ${INITRD_SIZE_MAX} ]; then
268         error 1 "Exceeded the maximum size (${INITRD_SIZE_MAX} MB)"
269 fi
270
271 create_vn
272 make_hier
273 copy_rescue
274 copy_content
275 print_info
276 destroy_vn
277 rm -rf ${BUILD_DIR}
278
279 echo -n "Compressing ${INITRD_FILE} ..."
280 gzip -9 ${INITRD_FILE}
281 echo " OK"
282
283 if [ -f "${INITRD_DEST}" ]; then
284         echo -n "Backing up ${INITRD_DEST} ..."
285         mv ${INITRD_DEST} ${INITRD_DEST}.old
286         echo " OK (${INITRD_DEST}.old)"
287 fi
288
289 echo -n "Installing ${INITRD_FILE}.gz to ${INITRD_DEST} ..."
290 install -o root -g wheel -m 444 ${INITRD_FILE}.gz ${INITRD_DEST}
291 echo " OK"
292 rm -f ${INITRD_FILE}.gz