#
# Aaron Klingaman <alk@absarokasoft.com>
# Mark Huang <mlhuang@cs.princeton.edu>
-# Copyright (C) 2004-2006 The Trustees of Princeton University
+# Copyright (C) 2004-2007 The Trustees of Princeton University
#
-# $Id: build.sh,v 1.35 2006/04/07 03:58:07 mlhuang Exp $
+# $Id$
#
PATH=/sbin:/bin:/usr/sbin:/usr/bin
CONFIGURATION=default
NODE_CONFIGURATION_FILE=
+TYPES="usb iso usb_serial iso_serial"
+# Leave 4 MB of free space
+FREE_SPACE=4096
+CUSTOM_DIR=
+OUTPUT_BASE=
+MKISOFS_OPTS="-R -J -r -f -b isolinux.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table"
usage()
{
echo "Usage: build.sh [OPTION]..."
- echo " -c name (Deprecated) Static configuration to use (default: $CONFIGURATION)"
- echo " -f planet.cnf Node to customize CD for (default: none)"
- echo " -h This message"
+ echo " -c name (Deprecated) Static configuration to use (default: $CONFIGURATION)"
+ echo " -f planet.cnf Node to customize CD for (default: none)"
+ echo " -t 'types' Build the specified images (default: $TYPES)"
+ echo " -a Build all supported images"
+ echo " -C custom-dir Custom directory"
+ echo " -O output-base The basename of the generated files (default: PLC_NAME-BootCD-VERSION)"
+ echo " -h This message"
exit 1
}
# Get options
-while getopts "c:f:h" opt ; do
+while getopts "O:c:f:t:C:ah" opt ; do
case $opt in
- c)
- CONFIGURATION=$OPTARG
- ;;
- f)
- NODE_CONFIGURATION_FILE=$OPTARG
- ;;
- h|*)
- usage
- ;;
+ c)
+ CONFIGURATION=$OPTARG
+ ;;
+ f)
+ NODE_CONFIGURATION_FILE=$OPTARG
+ ;;
+ t)
+ TYPES="$OPTARG"
+ ;;
+ C)
+ CUSTOM_DIR="$OPTARG"
+ ;;
+ O)
+ OUTPUT_BASE="$OPTARG"
+ ;;
+ a)
+ TYPES="usb iso usb_serial iso_serial usb_cramfs iso_cramfs usb_cramfs_serial iso_cramfs_serial"
+ ;;
+ h|*)
+ usage
+ ;;
esac
done
# Root of the isofs
isofs=$PWD/build/isofs
-# Build reference image if it does not exist. This should only need to
-# be executed once at build time, never at run time.
-if [ ! -f $isofs/bootcd.img ] ; then
- ./prep.sh
+# The reference image is expected to have been built by prep.sh (see .spec)
+# we disable the initial logic that called prep.sh if that was not the case
+# this is because prep.sh needs to know pldistro
+if [ ! -f $isofs/bootcd.img -o ! -f build/version.txt ] ; then
+ echo "You have to run prep.sh prior to calling $0 - exiting"
+ exit 1
fi
# build/version.txt written by prep.sh
if [ -f /etc/planetlab/plc_config ] ; then
# Source PLC configuration
. /etc/planetlab/plc_config
-elif [ -d configurations/$CONFIGURATION ] ; then
+fi
+
+### This support for backwards compatibility can be taken out in the
+### future. RC1 based MyPLCs set $PLC_BOOT_SSL_CRT in the plc_config
+### file, but >=RC2 based bootcd assumes that $PLC_BOOT_CA_SSL_CRT is
+### set.
+if [ -z "$PLC_BOOT_CA_SSL_CRT" -a ! -z "$PLC_BOOT_SSL_CRT" ] ; then
+ PLC_BOOT_CA_SSL_CRT=$PLC_BOOT_SSL_CRT
+fi
+
+# If PLC configuration is not valid, try a static configuration
+if [ -z "$PLC_BOOT_CA_SSL_CRT" -a -d configurations/$CONFIGURATION ] ; then
# (Deprecated) Source static configuration
. configurations/$CONFIGURATION/configuration
PLC_NAME="PlanetLab"
PLC_WWW_HOST="www.planet-lab.org"
PLC_WWW_PORT=80
if [ -n "$EXTRA_VERSION" ] ; then
- BOOTCD_VERSION="$BOOTCD_VERSION $EXTRA_VERSION"
+ BOOTCD_VERSION="$BOOTCD_VERSION $EXTRA_VERSION"
fi
PLC_BOOT_HOST=$PRIMARY_SERVER
PLC_BOOT_SSL_PORT=$PRIMARY_SERVER_PORT
- PLC_BOOT_SSL_CRT=configurations/$CONFIGURATION/$PRIMARY_SERVER_CERT
+ PLC_BOOT_CA_SSL_CRT=configurations/$CONFIGURATION/$PRIMARY_SERVER_CERT
PLC_ROOT_GPG_KEY_PUB=configurations/$CONFIGURATION/$PRIMARY_SERVER_GPG
fi
FULL_VERSION_STRING="$PLC_NAME BootCD $BOOTCD_VERSION"
+echo "* Building images for $FULL_VERSION_STRING"
+
+# From within a myplc chroot /usr/tmp is too small
+# to build all possible images, whereas /data is part of the host
+# filesystem and usually has sufficient space. What we
+# should do is check whether the expected amount of space
+# is available.
+BUILDTMP=/usr/tmp
+if [ -d /data/tmp ] ; then
+ isreadonly=$(mktemp /data/tmp/isreadonly.XXXXXX || /bin/true)
+ if [ -n "$isreadonly" ] ; then
+ rm -f "$isreadonly"
+ BUILDTMP=/data/tmp
+ fi
+fi
+
+declare -a _CLEANUPS=()
+function do_cleanup()
+{
+ cd /
+ for i in "${_CLEANUPS[@]}"; do
+ $i
+ done
+}
+function push_cleanup()
+{
+ _CLEANUPS=( "${_CLEANUPS[@]}" "$*" )
+}
+function pop_cleanup()
+{
+ unset _CLEANUPS[$((${#_CLEANUPS[@]} - 1))]
+}
+
+trap "do_cleanup" ERR INT EXIT
+
+BUILDTMP=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+push_cleanup rm -fr "${BUILDTMP}"
+mkdir "${BUILDTMP}/isofs"
+for i in "$isofs"/{bootcd.img,kernel}; do
+ ln -s "$i" "${BUILDTMP}/isofs"
+done
+cp "/usr/lib/syslinux/isolinux.bin" "${BUILDTMP}/isofs"
+isofs="${BUILDTMP}/isofs"
+
# Root of the ISO and USB images
-overlay=$(mktemp -d /tmp/overlay.XXXXXX)
+echo "* Populating root filesystem..."
+overlay="${BUILDTMP}/overlay"
install -d -m 755 $overlay
-trap "rm -rf $overlay" ERR
+push_cleanup rm -fr $overlay
# Create version files
echo "* Creating version files"
# but never got around to it. Just install the same parameters for
# both for now.
for dir in $overlay/usr/boot $overlay/usr/boot/backup ; do
- install -D -m 644 $PLC_BOOT_SSL_CRT $dir/cacert.pem
- install -D -m 644 $PLC_ROOT_GPG_KEY_PUB $dir/pubring.gpg
- echo "$PLC_BOOT_HOST" >$dir/boot_server
- echo "$PLC_BOOT_SSL_PORT" >$dir/boot_server_port
- echo "/boot/" >$dir/boot_server_path
+ install -D -m 644 $PLC_BOOT_CA_SSL_CRT $dir/cacert.pem
+ install -D -m 644 $PLC_ROOT_GPG_KEY_PUB $dir/pubring.gpg
+ echo "$PLC_BOOT_HOST" >$dir/boot_server
+ echo "$PLC_BOOT_SSL_PORT" >$dir/boot_server_port
+ echo "/boot/" >$dir/boot_server_path
done
# (Deprecated) Install old-style boot server configuration files
-install -D -m 644 $PLC_BOOT_SSL_CRT $overlay/usr/bootme/cacert/$PLC_BOOT_HOST/cacert.pem
+install -D -m 644 $PLC_BOOT_CA_SSL_CRT $overlay/usr/bootme/cacert/$PLC_BOOT_HOST/cacert.pem
echo "$FULL_VERSION_STRING" >$overlay/usr/bootme/ID
echo "$PLC_BOOT_HOST" >$overlay/usr/bootme/BOOTSERVER
echo "$PLC_BOOT_HOST" >$overlay/usr/bootme/BOOTSERVER_IP
(cd $overlay && find . | cpio --quiet -c -o) | gzip -9 >$isofs/overlay.img
rm -rf $overlay
-trap - ERR
+pop_cleanup
+
+if [ -n "$CUSTOM_DIR" ]; then
+ echo "* Compressing custom image"
+ (cd "$CUSTOM_DIR" && find . | cpio --quiet -c -o) | gzip -9 >$isofs/custom.img
+fi
# Calculate ramdisk size (total uncompressed size of both archives)
-ramdisk_size=$(gzip -l $isofs/bootcd.img $isofs/overlay.img | tail -1 | awk '{ print $2; }') # bytes
-ramdisk_size=$(($ramdisk_size / 1024)) # kilobytes
+ramdisk_size=$(gzip -l $isofs/bootcd.img $isofs/overlay.img ${CUSTOM_DIR:+$isofs/custom.img} | tail -1 | awk '{ print $2; }') # bytes
+ramdisk_size=$((($ramdisk_size + 1023) / 1024)) # kilobytes
-# Write isolinux configuration
echo "$FULL_VERSION_STRING" >$isofs/pl_version
-cat >$isofs/isolinux.cfg <<EOF
+
+popd
+
+function build_iso()
+{
+ local iso="$1"
+ local serial=$2
+ local custom=$3
+
+ # Write isolinux configuration
+ cat >$isofs/isolinux.cfg <<EOF
+${serial:+SERIAL 0 115200}
+DEFAULT kernel
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=ttyS0,115200n8}
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
+
+ # Create ISO image
+ echo "* Creating ISO image"
+ mkisofs -o "$iso" \
+ $MKISOFS_OPTS \
+ $isofs
+}
+
+# Create USB image
+function build_usb()
+{
+ echo -n "* Creating USB image... "
+ local usb="$1"
+ local serial=$2
+ local custom=$3
+
+ mkfs.vfat -C "$usb" $(($(du -Lsk $isofs | awk '{ print $1; }') + $FREE_SPACE))
+
+ # Populate it
+ echo -n " populating USB image... "
+ mcopy -bsQ -i "$usb" "$isofs"/* ::/
+
+ # Use syslinux instead of isolinux to make the image bootable
+ tmp="${BUILDTMP}/syslinux.cfg"
+ cat >$tmp <<EOF
+${serial:+SERIAL 0 115200}
DEFAULT kernel
-APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img root=/dev/ram0 rw
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${serial:+console=ttyS0,115200n8}
DISPLAY pl_version
PROMPT 0
TIMEOUT 40
+EOF
+ mdel -i "$usb" ::/isolinux.cfg 2>/dev/null || :
+ mcopy -i "$usb" "$tmp" ::/syslinux.cfg
+ rm -f "$tmp"
+
+ echo "making USB image bootable."
+ syslinux "$usb"
+}
+
+
+# Setup CRAMFS related support
+function prepare_cramfs()
+{
+ [ -n "$CRAMFS_PREPARED" ] && return 0
+ local custom=$1
+
+ echo "* Setting up CRAMFS-based images"
+ local tmp="${BUILDTMP}/cramfs-tree"
+ mkdir -p "$tmp"
+ push_cleanup rm -rf $tmp
+ pushd $tmp
+ gzip -d -c $isofs/bootcd.img | cpio -diu
+ gzip -d -c $isofs/overlay.img | cpio -diu
+ [ -n "$custom" ] && \
+ gzip -d -c $isofs/custom.img | cpio -diu
+
+ # clean out unnecessary rpm lib
+ echo "* clearing var/lib/rpm/*"
+ rm -f var/lib/rpm/*
+
+ # bootcd requires this directory
+ mkdir -p mnt/confdevice
+
+ # relocate various directory to /tmp
+ rm -rf root
+ ln -fs /tmp/root root
+ ln -fs /sbin/init linuxrc
+ ln -fs /tmp/resolv.conf etc/resolv.conf
+ ln -fs /tmp/etc/mtab etc/mtab
+
+ # have pl_rsysinit copy over appropriate etc & var directories into /tmp/etc/
+ # make /tmp/etc
+ echo "* renaming dirs in ./etc"
+ pushd etc
+ for dir in `find * -type d -prune | grep -v rc.d`; do
+ mv ${dir} ${dir}_o
+ ln -fs /tmp/etc/${dir} ${dir}
+ done
+ popd
+
+ echo "* renaming dirs in ./var"
+ # rename all top-level directories and put in a symlink to /tmp/var
+ pushd var
+ for dir in `find * -type d -prune`; do
+ mv ${dir} ${dir}_o
+ ln -fs /tmp/var/${dir} ${dir}
+ done
+ popd
+
+ # overwrite fstab to mount / as cramfs and /tmp as tmpfs
+ echo "* Overwriting etc/fstab to use cramfs and tmpfs"
+ rm -f ./etc/fstab
+ cat >./etc/fstab <<EOF
+/dev/ram0 / cramfs ro 0 0
+none /dev/pts devpts gid=5,mode=620 0 0
+none /proc proc defaults 0 0
+none /sys sysfs defaults 0 0
EOF
-# Change back to output directory
+ pushd dev
+ rm -f console
+ mknod console c 5 1
+ #for i in 0 1 2 3 4 5 6 7 8; do rm -f ram${i} ; done
+ #for i in 0 1 2 3 4 5 6 7 8; do mknod ram${i} b 1 ${i} ; done
+ #ln -fs ram1 ram
+ #ln -fs ram0 ramdisk
+ popd
+
+ # update etc/inittab to start with pl_rsysinit
+ sed -i 's,pl_sysinit,pl_rsysinit,' etc/inittab
+
+ # modify inittab to have a serial console
+ echo "T0:23:respawn:/sbin/agetty -L ttyS0 9600 vt100" >> etc/inittab
+ # and let root log in
+ echo "ttyS0" >> etc/securetty
+
+ # calculate the size of /tmp based on the size of /etc & /var + 8MB slack
+ etcsize=$(du -s ./etc | awk '{ print $1 }')
+ varsize=$(du -s ./var | awk '{ print $1 }')
+ let msize=($varsize+$etcsize+8192)/1024
+
+
+ # generate pl_rsysinit
+ cat > etc/rc.d/init.d/pl_rsysinit <<EOF
+#!/bin/sh
+# generated by build.sh
+echo -n "pl_rsysinit: preparing /etc and /var for pl_sysinit..."
+mount -t tmpfs -orw,size=${msize}M,mode=1777 tmpfs /tmp
+mkdir -p /tmp/root
+mkdir -p /tmp/etc
+touch /tmp/etc/resolv.conf
+touch /tmp/etc/mtab
+mkdir -p /tmp/var
+
+# make mtab happy
+echo "tmpfs /tmp tmpfs rw,size=${msize}M,mode=1777 1 1" > /tmp/etc/mtab
+
+# copy over directory contents of all _o directories from /etc and /var
+# /tmp/etc and /tmp/var
+pushd /etc
+for odir in \$(cd /etc && ls -d *_o); do dir=\$(echo \$odir | sed 's,\_o$,,'); (mkdir -p /tmp/etc/\$dir && cd \$odir && find . | cpio -p -d -u /tmp/etc/\$dir); done
+popd
+pushd /var
+for odir in \$(cd /var && ls -d *_o); do dir=\$(echo \$odir | sed 's,\_o$,,'); (mkdir -p /tmp/var/\$dir && cd \$odir && find . | cpio -p -d -u /tmp/var/\$dir); done
popd
-# Create ISO image
-echo "* Creating ISO image"
-iso="$PLC_NAME-BootCD-$BOOTCD_VERSION.iso"
-mkisofs -o "$iso" \
- -R -allow-leading-dots -J -r \
- -b isolinux.bin -c boot.cat \
- -no-emul-boot -boot-load-size 4 -boot-info-table \
- $isofs
+echo "done"
+# hand over to pl_sysinit
+echo "pl_rsysinit: handing over to pl_sysinit"
+/etc/init.d/pl_sysinit
+EOF
+ chmod +x etc/rc.d/init.d/pl_rsysinit
-# Create USB image
-echo "* Creating USB image"
-usb="$PLC_NAME-BootCD-$BOOTCD_VERSION.usb"
+ popd
-# Leave 1 MB of free space on the VFAT filesystem
-mkfs.vfat -C "$usb" $(($(du -sk $isofs | awk '{ print $1; }') + 1024))
+ # create the cramfs image
+ echo "* Creating cramfs image"
+ mkfs.cramfs $tmp/ ${BUILDTMP}/cramfs.img
+ cramfs_size=$(($(du -sk ${BUILDTMP}/cramfs.img | awk '{ print $1; }') + 1))
+ rm -rf $tmp
+ pop_cleanup
+}
-# Mount it
-tmp=$(mktemp -d /tmp/bootcd.XXXXXX)
-mount -o loop "$usb" $tmp
-trap "umount $tmp; rm -rf $tmp" ERR
+# Create ISO CRAMFS image
+function build_iso_cramfs()
+{
+ local iso="$1"
+ local serial=$2
+ prepare_cramfs $3
+ echo "* Creating ISO CRAMFS-based image"
+
+ local tmp="${BUILDTMP}/cramfs-iso"
+ mkdir -p "$tmp"
+ push_cleanup rm -rf $tmp
+ (cd $isofs && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
+ cat >$tmp/isolinux.cfg <<EOF
+${serial:+SERIAL 0 9600}
+DEFAULT kernel
+APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=ttyS0,9600n8}
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
-# Populate it
-echo "* Populating USB image"
-(cd $isofs && find . | cpio -p -d -u $tmp/)
+ cp ${BUILDTMP}/cramfs.img $tmp
+ mkisofs -o "$iso" \
+ "$MKISOFS_OPTS" \
+ $tmp
-# Use syslinux instead of isolinux to make the image bootable
-mv $tmp/isolinux.cfg $tmp/syslinux.cfg
-umount $tmp
-rmdir $tmp
-trap - ERR
+ rm -fr "$tmp"
+ pop_cleanup
+}
-echo "* Making USB image bootable"
-$srcdir/syslinux/unix/syslinux "$usb"
+# Create USB CRAMFS based image
+function build_usb_cramfs()
+{
+ local usb="$1"
+ local serial=$2
+ prepare_cramfs $3
+ echo "* Creating USB CRAMFS based image"
+
+ let vfat_size=${cramfs_size}+$FREE_SPACE
+
+ # Make VFAT filesystem for USB
+ mkfs.vfat -C "$usb" $vfat_size
+
+ # Populate it
+ echo "* Populating USB with overlay images and cramfs"
+ mcopy -bsQ -i "$usb" $isofs/kernel $isofs/pl_version ::/
+ mcopy -bsQ -i "$usb" ${BUILDTMP}/cramfs.img ::/
+
+ # Use syslinux instead of isolinux to make the image bootable
+ tmp="${BUILDTMP}/syslinux.cfg"
+ cat >$tmp <<EOF
+${serial:+SERIAL 0 9600}
+DEFAULT kernel
+APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro ${serial:+console=ttyS0,9600n8}
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
+ mcopy -bsQ -i "$usb" "$tmp" ::/syslinux.cfg
+ rm -f "$tmp"
+
+ echo "* Making USB CRAMFS based image bootable"
+ syslinux "$usb"
+}
+
+function type_to_name()
+{
+ echo $1 | sed '
+ s/usb$/.usb/;
+ s/usb_serial$/-serial.usb/;
+ s/iso$/.iso/;
+ s/iso_serial$/-serial.iso/;
+ s/usb_cramfs$/-cramfs.usb/;
+ s/usb_cramfs_serial$/-cramfs-serial.usb/;
+ s/iso_cramfs$/-cramfs.iso/;
+ s/iso_cramfs_serial$/-cramfs-serial.iso/;
+ '
+}
+
+[ -z "$OUTPUT_BASE" ] && OUTPUT_BASE="$PLC_NAME-BootCD-$BOOTCD_VERSION"
+
+for t in $TYPES; do
+ serial=
+ tname=`type_to_name $t`
+ if [[ "$t" == *_serial ]]; then
+ serial=1
+ t=`echo $t | sed 's/_serial$//'`
+ fi
+ build_$t "${OUTPUT_BASE}${tname}" $serial $CUSTOM_DIR
+done
exit 0