summary refs log tree commit diff
path: root/mklive.sh.in
blob: e3c78c7a47dd89af6b81fe764d42b6038fcb12ef (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
#!/bin/bash
#-
# Copyright (c) 2009-2013 Juan Romero Pardines.
# All rights reserved.
#
# 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 ``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 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.
#-
set -E
trap "echo; error_out $LINENO $?" INT TERM HUP ERR

info_msg() {
    printf "\033[1m$@\n\033[m"
}

error_out() {
    info_msg "There was an error in line $1 ... cleaning up $BUILDDIR, exiting."

    umount_kernel_fs

    [ -d "$BUILDDIR" ] && rm -rf "$BUILDDIR"

    exit 1
}

umount_kernel_fs() {
    for f in sys/fs/cgroup/systemd sys/fs/cgroup dev/shm dev/pts dev proc sys run; do
        umount -f $ROOTFS/kernel_temp/$f &>/dev/null
    done
}

write_etc_motd() {
    cat >> "$ROOTFS/etc/motd" <<_EOF
###############################################################################
Autogenerated by void-mklive "@@MKLIVE_VERSION@@"
-------------------------------------------------------------------------------

Welcome to the Void Linux Live system, you have been autologged in.
This user has full sudo(8) permissions without any password, be careful
executing commands through sudo(8).

To start the installation please type:

$ sudo void-installer

and follow the on-screen instructions. Thanks for trying Void Linux.

###############################################################################
_EOF
}

write_conf_file() {
    cat > "$1" <<_EOF
# *-*- sh -*-*
# Default configuration file for vmklive-@VERSION@.
#
# List of packages to be installed into the live image.
# By default the 'base-system-live' pkg is always installed because
# it is required to generate a working image.
#PACKAGE_LIST="foo blah"

# Syslinux splash image.
SPLASH_IMAGE=/usr/share/void-artwork/splash.png

# Default keymap to use.
KEYMAP=us

# Default locale to use.
LOCALE=en_US.UTF-8

# Path to XBPS utilities.
#XBPS_INSTALL_CMD=xbps-install
#XBPS_QUERY_CMD=xbps-query
#XBPS_RECONFIGURE_CMD=xbps-reconfigure
#XBPS_REMOVE_CMD=xbps-remove
#XBPS_RINDEX_CMD=xbps-rindex
#XBPS_UHELPER_CMD=xbps-uhelper

# XBPS cache directory to install packages from.
#REPOSITORY_CACHE=/blah/foo

_EOF
    chmod 644 "$1"
}

usage()
{
    cat <<_EOF
Usage: $(basename $0) [options]

Options:
 -C file            Path to configuration file (defaults to ~/.mklive.conf)
 -c (gzip|bzip2|xz) Compression type for the squashfs/initramfs image.
 -l "pkgname ..."   Generate a local repository in the image with these packages.
                    Packages must be delimited by blanks.
 -r rootdir         Use this directory to generate the image (if unset,
                    current working directory will be used).
 -o outfile         Output file name for the ISO image.
 -s splash          Splash image file for isolinux.
_EOF
    exit 1
}

install_packages() {
    for f in ${PACKAGE_LIST}; do
        info_msg "  $f"
    done
    # Check that all pkgs are reachable.
    ${XBPS_INSTALL_CMD} ${XBPS_ARGS} -n ${PACKAGE_LIST} >>$LOGFILE 2>&1
    if [ $? -ne 0 ]; then
        info_msg "Missing required binary packages, exiting..."
        error_out
    fi
    ${XBPS_INSTALL_CMD} ${XBPS_ARGS} ${PACKAGE_LIST} >>$LOGFILE 2>&1
    ${XBPS_INSTALL_CMD} ${XBPS_ARGS} -u >>$LOGFILE 2>&1
    ${XBPS_REMOVE_CMD} ${XBPS_ARGS} -o >>$LOGFILE 2>&1
    ${XBPS_QUERY_CMD} -r "$ROOTFS" -l > "${OUTPUT_FILE%.iso}"-package-list.txt

    # Reconfigure all pkgs again via linux-user-chroot.
    chroot $ROOTFS /usr/sbin/xbps-reconfigure -fa >>$LOGFILE 2>&1
}

generate_initramfs() {
    # Install required pkgs in a temporary rootdir to create
    # the initramfs and to copy required files.
    $XBPS_INSTALL_CMD -r $ROOTFS/kernel_temp -y \
        base-system void-mklive >>$LOGFILE 2>&1

    # Install some required utilities from util-linux.
    install -Dm755 $ROOTFS/kernel_temp/usr/bin/mount "$ROOTFS/usr/bin/mount"
    install -Dm755 $ROOTFS/kernel_temp/usr/sbin/agetty "$ROOTFS/usr/sbin/agetty"
    install -Dm755 $ROOTFS/kernel_temp/usr/bin/lsblk "$ROOTFS/usr/bin/lsblk"
    # Install stdbuf from coreutils, required by void-installer.
    install -Dm755 $ROOTFS/kernel_temp/usr/bin/stdbuf "$ROOTFS/usr/bin/stdbuf"
    install -Dm755 $ROOTFS/kernel_temp/usr/libexec/coreutils/libstdbuf.so \
        "$ROOTFS/usr/libexec/coreutils/libstdbuf.so"

    chroot $ROOTFS/kernel_temp /usr/bin/dracut --no-hostonly \
        --add " dmsquash-live vmklive " --${COMPRESSTYPE} \
        "/boot/initrd.lz" >>$LOGFILE 2>&1

    umount_kernel_fs

    mv $ROOTFS/kernel_temp/boot/initrd.lz $BOOT_DIR
    # We rely on pam now, so let's install the host login config.
    install -Dm644 $ROOTFS/kernel_temp/etc/pam.d/login \
        "$ROOTFS/etc/pam.d/login"
    # Remove pam_motd.so; busybox login already prints it.
    sed -e '/^.*pam_motd.so*/d' -i "$ROOTFS/etc/pam.d/login"
}

copy_kernel_and_modules() {
    cp -a $ROOTFS/kernel_temp/boot/vmlinuz-${KERNELVERSION} \
        $BOOT_DIR/vmlinuz
    mkdir -p $ROOTFS/lib/modules
    cp -a $ROOTFS/kernel_temp/lib/modules/${KERNELVERSION} \
        $ROOTFS/lib/modules

    # remove temporary rootfs.
    rm -rf $ROOTFS/kernel_temp
}

generate_local_repository() {
    mkdir -p $ROOTFS/packages
    pkgs=$($XBPS_INSTALL_CMD -r /tmp/blah -n ${LOCALREPO_PKGLIST})
    set -- ${pkgs}
    while [ $# -ne 0 ]; do
        pkg=$1; action=$2; arch=$3; repo=$4;
        shift 4
        bpkg=${repo}/${pkg}.${arch}.xbps
        cp -f $bpkg $ROOTFS/packages
    done
    LD_LIBRARY_PATH="$ROOTFS/usr/lib" \
        $ROOTFS/usr/sbin/$XBPS_RINDEX_CMD -a $ROOTFS/packages/*.xbps 2>&1 >>$LOGFILE
}

generate_isolinux_boot() {
    cp -f $SYSLINUX_DATADIR/isolinux.bin "$ISOLINUX_DIR"
    cp -f $SYSLINUX_DATADIR/ldlinux.c32 "$ISOLINUX_DIR"
    cp -f $SYSLINUX_DATADIR/libcom32.c32 "$ISOLINUX_DIR"
    cp -f $SYSLINUX_DATADIR/vesamenu.c32 "$ISOLINUX_DIR"
    cp -f $SYSLINUX_DATADIR/libutil.c32 "$ISOLINUX_DIR"
    cp -f $MKLIVE_DATADIR/isolinux.cfg.in \
        "$ISOLINUX_DIR"/isolinux.cfg

    if [ -f "$SPLASH_IMAGE" ]; then
        cp -f $SPLASH_IMAGE "$ISOLINUX_DIR"
    fi
    sed -i  -e "s|@@SPLASHIMAGE@@|$(basename $SPLASH_IMAGE)|" \
        -e "s|@@KERNVER@@|${KERNELVERSION}|" \
        -e "s|@@KEYMAP@@|${KEYMAP}|" \
        -e "s|@@ARCH@@|$(uname -m)|" \
        -e "s|@@LOCALE@@|${LOCALE}|" $ISOLINUX_DIR/isolinux.cfg
}

generate_grub_efi_boot() {
    cp -f $MKLIVE_DATADIR/grub.cfg $GRUB_DIR
    cp -f $MKLIVE_DATADIR/grub_void.cfg.in $GRUB_DIR/grub_void.cfg
    sed -i  -e "s|@@SPLASHIMAGE@@|$(basename $SPLASH_IMAGE)|" \
        -e "s|@@KERNVER@@|${KERNELVERSION}|" \
        -e "s|@@KEYMAP@@|${KEYMAP}|" \
        -e "s|@@ARCH@@|$(uname -m)|" \
        -e "s|@@LOCALE@@|${LOCALE}|" $GRUB_DIR/grub_void.cfg
    mkdir -p $GRUB_DIR/fonts $GRUB_DIR/locale
    cp -f $GRUB_DATADIR/unicode.pf2 $GRUB_DIR/fonts
    cp -f /boot/grub/locale/* $GRUB_DIR/locale

    # Create EFI vfat image.
    dd if=/dev/zero of=$GRUB_DIR/efiboot.img bs=1024 count=4096  >>$LOGFILE 2>&1
    mkfs.vfat -F12 -S 512 -n "grub_uefi" "$GRUB_DIR/efiboot.img" >>$LOGFILE 2>&1

    GRUB_EFI_TMPDIR="$(mktemp --tmpdir=$HOME -d)"
    LOOP_DEVICE="$(losetup --show --find ${GRUB_DIR}/efiboot.img)"
    mount -o rw,flush -t vfat "${LOOP_DEVICE}" "${GRUB_EFI_TMPDIR}" >>$LOGFILE 2>&1

    mkdir -p "${GRUB_EFI_TMPDIR}/EFI/boot/"
    cd "$BUILDDIR"
    grub-mkstandalone --directory="/usr/lib/grub/x86_64-efi" \
        --format="x86_64-efi" \
        --compression="xz" --output="${GRUB_EFI_TMPDIR}/EFI/boot/bootx64.efi" \
        "boot/grub/grub.cfg" >>$LOGFILE 2>&1
    umount "$GRUB_EFI_TMPDIR"
    losetup --detach "${LOOP_DEVICE}"
    rm -rf $GRUB_EFI_TMPDIR
}

generate_squashfs() {
    # Find out required size for the rootfs and create an ext3fs image off it.
    ROOTFS_SIZE=$(du -sk "$ROOTFS"|awk '{print $1}')
    mkdir -p "$BUILDDIR/tmp/LiveOS"
    dd if=/dev/zero of="$BUILDDIR/tmp/LiveOS/ext3fs.img" \
        bs="$((${ROOTFS_SIZE}+($ROOTFS_SIZE/6)))K" count=1 >>$LOGFILE 2>&1
    mkdir -p "$BUILDDIR/tmp-rootfs"
    mkfs.ext3 -F -m1 "$BUILDDIR/tmp/LiveOS/ext3fs.img" >>$LOGFILE 2>&1
    mount -o loop "$BUILDDIR/tmp/LiveOS/ext3fs.img" "$BUILDDIR/tmp-rootfs"
    cd $BUILDDIR
    cp -a rootfs/* tmp-rootfs/
    umount -f "$BUILDDIR/tmp-rootfs"
    mkdir -p "$BUILDDIR/LiveOS"

    mksquashfs "$BUILDDIR/tmp" "$BUILDDIR/LiveOS/squashfs.img" \
        -comp ${COMPRESSTYPE} >>$LOGFILE 2>&1
    chmod 444 "$BUILDDIR/LiveOS/squashfs.img"
    # Remove rootfs and temporary dirs, we don't need them anymore.
    rm -rf "$ROOTFS" "$BUILDDIR/tmp-rootfs" "$BUILDDIR/tmp"
}

generate_iso_image() {
    xorriso -as mkisofs \
        -iso-level 3 -rock -joliet \
        -max-iso9660-filenames -omit-period \
        -omit-version-number -relaxed-filenames -allow-lowercase \
        -volid "VOID_LIVE" \
        -eltorito-boot boot/isolinux/isolinux.bin \
        -eltorito-catalog boot/isolinux/boot.cat \
        -no-emul-boot -boot-load-size 4 -boot-info-table \
        -eltorito-alt-boot --efi-boot boot/grub/efiboot.img -no-emul-boot \
        -isohybrid-mbr $SYSLINUX_DATADIR/isohdpfx.bin \
        -output "$OUTPUT_FILE" "$BUILDDIR" >>$LOGFILE 2>&1
}

#
# main()
#
while getopts "C:c:l:o:r:s:h" opt; do
    case $opt in
        C) CONFIG_FILE="$OPTARG";;
        c) COMPRESSTYPE="$OPTARG";;
        l) LOCALREPO_PKGLIST="$OPTARG";;
        o) OUTPUT_FILE="$OPTARG";;
        r) ROOTDIR="$OPTARG";;
        s) SPLASH_IMAGE="$OPTARG";;
        h) usage;;
    esac
done
shift $(($OPTIND - 1))

# Set defaults
if [ -z "$CONFIG_FILE" ]; then
    CONFIG_FILE="$HOME/.mklive.conf"
fi
LOGFILE="$(mktemp -t vmklive-XXXXXXXXXX.log)"

if [ -z "$SYSLINUX_DATADIR" ]; then
    SYSLINUX_DATADIR=/usr/share/syslinux
fi
if [ -z "$GRUB_DATADIR" ]; then
    GRUB_DATADIR=/usr/share/grub
fi
if [ -z "$MKLIVE_DATADIR" ]; then
    MKLIVE_DATADIR=/usr/share/void-mklive
fi
if [ -z "$SPLASH_IMAGE" ]; then
    SPLASH_IMAGE=/usr/share/void-artwork/splash.png
fi
if [ -z "$XBPS_INSTALL_CMD" ]; then
    XBPS_INSTALL_CMD=xbps-install
fi
if [ -z "$XBPS_REMOVE_CMD" ]; then
    XBPS_REMOVE_CMD=xbps-remove
fi
if [ -z "$XBPS_QUERY_CMD" ]; then
    XBPS_QUERY_CMD=xbps-query
fi
if [ -z "$XBPS_RINDEX_CMD" ]; then
    XBPS_RINDEX_CMD=xbps-rindex
fi
if [ -z "$XBPS_UHELPER_CMD" ]; then
    XBPS_UHELPER_CMD=xbps-uhelper
fi
if [ -z "$XBPS_RECONFIGURE_CMD" ]; then
    XBPS_RECONFIGURE_CMD=xbps-reconfigure
fi
if [ -z "$COMPRESSTYPE" ]; then
    COMPRESSTYPE=xz
fi

# Create or read configuration file.
if [ ! -r $CONFIG_FILE ]; then
    info_msg "Creating config file at $CONFIG_FILE."
    write_conf_file $CONFIG_FILE
fi

. $CONFIG_FILE

if [ -z "$PACKAGE_LIST" ]; then
    PACKAGE_LIST="base-system-live"
else
    PACKAGE_LIST="base-system-live $PACKAGE_LIST"
fi
if [ ! -f $SYSLINUX_DATADIR/isolinux.bin ]; then
    echo "Missing required isolinux files in $SYSLINUX_DATADIR, exiting..."
    exit 1
fi

# Check for root permissions.
if [ "$(id -u)" -ne 0 ]; then
    echo "Must be run as root, exiting..."
    exit 1
fi

ISO_VOLUME="VOID_LIVE"
if [ -n "$ROOTDIR" ]; then
    BUILDDIR=$(mktemp --tmpdir="$ROOTDIR" -d)
else
    BUILDDIR=$(mktemp --tmpdir="$(pwd -P)" -d)
fi
BUILDDIR=$(readlink -f $BUILDDIR)
ROOTFS="$BUILDDIR/rootfs"
BOOT_DIR="$BUILDDIR/boot"
ISOLINUX_DIR="$BOOT_DIR/isolinux"
GRUB_DIR="$BOOT_DIR/grub"
ISOLINUX_CFG="$ISOLINUX_DIR/isolinux.cfg"

mkdir -p $ISOLINUX_DIR $GRUB_DIR
#
# Check there are repos registered before anything.
#
${XBPS_QUERY_CMD} -L >/dev/null 2>&1
if [ $? -ne 0 ]; then
    echo "No repositories available, exiting..."
    error_out
fi

XBPS_ARGS="-r $ROOTFS -y"
if [ -n "$REPOSITORY_CACHE" ]; then
    XBPS_ARGS="$XBPS_ARGS -c $REPOSITORY_CACHE"
fi
XBPS_VERSION=$($XBPS_QUERY_CMD -V|awk '{print $2}')
case $XBPS_VERSION in
# XBPS >= 0.21
    [0-9].[2-9][1-9]*) ;;
    *) echo "Your xbps utilities are too old ($XBPS_VERSION), 0.21 is required."; exit 1;;
esac

KERNELVERSION=$($XBPS_QUERY_CMD -R --property version kernel)

if [ -z "$OUTPUT_FILE" ]; then
    OUTPUT_FILE="$HOME/void-live-$(uname -m)-${KERNELVERSION}-$(date +%Y%m%d).iso"
fi

info_msg "Redirecting stdout/stderr to $LOGFILE ..."
#
# Install live system and specified packages.
#
info_msg "[1/9] Installing packages into the rootfs..."
install_packages

#
# Prepare /etc/motd.
#
mkdir -p "$ROOTFS"/etc
write_etc_motd

#
# Generate the initramfs.
#
info_msg "[2/9] Generating initramfs image ($COMPRESSTYPE)..."
generate_initramfs

#
# Copy linux kernel and modules to rootfs.
#
info_msg "[3/9] Copying kernel image/modules from temporary rootfs..."
copy_kernel_and_modules

#
# Generate the package local repository for void-installer.
#
if [ -z "$LOCALREPO_PKGLIST" ]; then
    _skip="(disabled)"
fi
info_msg "[4/9] Generating package local repository ${_skip}..."
if [ -n "$LOCALREPO_PKGLIST" ]; then
    generate_local_repository
fi
#
# Generate the isolinux boot.
#
info_msg "[5/9] Generating isolinux support for PC-BIOS systems..."
generate_isolinux_boot

#
# Generate the GRUB EFI boot.
#
info_msg "[6/9] Generating GRUB support for EFI systems..."
generate_grub_efi_boot

#
# Generate the squashfs image from rootfs.
#
info_msg "[7/9] Generating squashfs image ($COMPRESSTYPE) from rootfs..."
generate_squashfs

#
# Generate the ISO image.
#
info_msg "[8/9] Generating ISO image..."
generate_iso_image

info_msg "[9/9] Removing build directory..."
rm -rf "$BUILDDIR"

hsize=$(du -sh "$OUTPUT_FILE"|awk '{print $1}')
info_msg "Created $(readlink -f $OUTPUT_FILE) ($hsize) successfully."

exit 0

# vim: set ts=4 sw=4 et: