* Added support to build images with the serial line as the console
Marc Fiuczynski [Wed, 23 Aug 2006 12:50:32 +0000 (12:50 +0000)]
* Added support to build cramfs based images, which lets one install
  on memory constrained systems.  These are only built when the -a
  flag

* Intermediate images are now built in /data (if available), rather
  than in /tmp.  The reason being that /tmp within a chroot'ed myplc
  environment does not have sufficient space.  Falls back to using
  /tmp if /data is not available

* Made build.sh be backwards compatible with an RC1 based MyPLC
  installations.

build.sh

index 968c457..bff2262 100755 (executable)
--- a/build.sh
+++ b/build.sh
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2004-2006 The Trustees of Princeton University
 #
-# $Id$
+# $Id: build.sh,v 1.40 2006/07/25 23:51:39 mlhuang Exp $
 #
 
 PATH=/sbin:/bin:/usr/sbin:/usr/bin
 
 CONFIGURATION=default
 NODE_CONFIGURATION_FILE=
+ALL=0
 
 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 "      -a              Build all images (default: only base images)"
     echo "     -h              This message"
     exit 1
 }
 
 # Get options
-while getopts "c:f:h" opt ; do
+while getopts "c:f:ah" opt ; do
     case $opt in
        c)
            CONFIGURATION=$OPTARG
@@ -36,6 +38,9 @@ while getopts "c:f:h" opt ; do
        f)
            NODE_CONFIGURATION_FILE=$OPTARG
            ;;
+       a)
+           ALL=1
+           ;;
        h|*)
            usage
            ;;
@@ -66,6 +71,14 @@ if [ -f /etc/planetlab/plc_config ] ; then
     . /etc/planetlab/plc_config
 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
@@ -85,8 +98,18 @@ fi
 
 FULL_VERSION_STRING="$PLC_NAME BootCD $BOOTCD_VERSION"
 
+echo "* Building images for $FULL_VERSION_STRING"
+
+# From within a myplc chroot /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.
+[ -d /data ] && BUILDTMP=/data || BUILDTMP=/tmp
+
 # Root of the ISO and USB images
-overlay=$(mktemp -d /tmp/overlay.XXXXXX)
+echo "* Populating root filesystem..."
+overlay=$(mktemp -d ${BUILDTMP}/overlay.XXXXXX)
 install -d -m 755 $overlay
 trap "rm -rf $overlay" ERR INT
 
@@ -208,29 +231,319 @@ mkisofs -o "$iso" \
     -no-emul-boot -boot-load-size 4 -boot-info-table \
     $isofs
 
+echo "* Creating ISO image with serial line support"
+iso="$PLC_NAME-BootCD-$BOOTCD_VERSION-serial.iso"
+cat >$isofs/isolinux.cfg <<EOF
+SERIAL 0 115200
+PROMPT 0
+TIMEOUT 120
+DISPLAY pl_version
+DEFAULT serial
+LABEL serial
+       KERNEL kernel
+       APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img root=/dev/ram0 rw  console=ttyS0,115200n8
+EOF
+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
+
 # Create USB image
-echo "* Creating USB image"
+echo -n "* Creating USB image... "
 usb="$PLC_NAME-BootCD-$BOOTCD_VERSION.usb"
 
 # Leave 1 MB of free space on the VFAT filesystem
 mkfs.vfat -C "$usb" $(($(du -sk $isofs | awk '{ print $1; }') + 1024))
 
 # Mount it
-tmp=$(mktemp -d /tmp/bootcd.XXXXXX)
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
 mount -o loop "$usb" $tmp
 trap "umount $tmp; rm -rf $tmp" ERR INT
 
 # Populate it
-echo "* Populating USB image"
+echo -n " populating USB image... "
 (cd $isofs && find . | cpio -p -d -u $tmp/)
 
 # Use syslinux instead of isolinux to make the image bootable
-mv $tmp/isolinux.cfg $tmp/syslinux.cfg
+rm -f $tmp/isolinux.cfg
+cat >$tmp/syslinux.cfg <<EOF
+DEFAULT kernel
+APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img root=/dev/ram0 rw
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
+umount $tmp
+rmdir $tmp
+trap - ERR INT
+
+echo "making USB image bootable."
+$srcdir/syslinux/unix/syslinux "$usb"
+
+
+# Create USB image with serial line support
+echo -n "* Creating USB image... "
+usb="$PLC_NAME-BootCD-$BOOTCD_VERSION-serial.usb"
+
+# Leave 1 MB of free space on the VFAT filesystem
+mkfs.vfat -C "$usb" $(($(du -sk $isofs | awk '{ print $1; }') + 1024))
+
+# Mount it
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+mount -o loop "$usb" $tmp
+trap "umount $tmp; rm -rf $tmp" ERR INT
+
+# Populate it
+echo -n " populating USB image... "
+(cd $isofs && find . | cpio -p -d -u $tmp/)
+
+# Use syslinux instead of isolinux to make the image bootable
+rm -f $tmp/isolinux.cfg
+cat >$tmp/syslinux.cfg <<EOF
+SERIAL 0 115200
+PROMPT 0
+TIMEOUT 120
+DISPLAY pl_version
+DEFAULT serial
+LABEL serial
+       KERNEL kernel
+       APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img root=/dev/ram0 rw  console=ttyS0,115200n8
+EOF
+
+umount $tmp
+rmdir $tmp
+trap - ERR INT
+
+echo "making USB image with serial line support bootable."
+$srcdir/syslinux/unix/syslinux "$usb"
+
+[ $ALL -eq 0 ] && exit 0
+
+# Setup CRAMFS related support
+echo "* Setting up CRAMFS-based images"
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+cramfs=$(mktemp ${BUILDTMP}/cramfs.XXXXXX)
+trap "$tmp; rm -rf $tmp $cramfs" ERR INT
+pushd $tmp
+gzip -d -c $isofs/bootcd.img  | cpio -diu
+gzip -d -c $isofs/overlay.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
+
+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
+
+#calculate the size of /tmp based on the size of /etc & /var + 8MB slack
+etcsize=$(du -s ./etc | awk '{ print $1 }')
+varsize=$(du -s ./etc | awk '{ print $1 }')
+let msize=($vsize+$esize+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
+
+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
+
+popd
+
+chown -R 0.0 $cramfs
+
+#create the cramfs image
+echo "* Creating cramfs image"
+mkfs.cramfs $tmp/ $cramfs
+# Leave 1 MB of free space on the VFAT filesystem
+cramfs_size=$(($(du -sk $cramfs | awk '{ print $1; }')))
+mv $cramfs ${BUILDTMP}/cramfs.img
+rm -rf $tmp
+trap - ERR INT
+
+# Create ISO CRAMFS image
+echo "* Creating ISO CRAMFS-based image"
+iso="$PLC_NAME-BootCD-$BOOTCD_VERSION-cramfs.iso"
+
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+trap "$tmp; rm -rf $tmp" ERR INT
+(cd $isofs && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
+cat >$tmp/isolinux.cfg <<EOF
+DEFAULT kernel
+APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro
+DISPLAY pl_version
+PROMPT 0
+TIMEOUT 40
+EOF
+
+cp ${BUILDTMP}/cramfs.img $tmp
+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 \
+    $tmp
+
+# Create ISO CRAMFS image with serial line support
+echo "* Creating ISO image with cramfs and serial line support"
+cat >$tmp/isolinux.cfg <<EOF
+SERIAL 0 115200
+PROMPT 0
+TIMEOUT 120
+DISPLAY pl_version
+DEFAULT serial
+LABEL serial
+       KERNEL kernel
+       APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro  console=ttyS0,115200n8
+EOF
+
+iso="$PLC_NAME-BootCD-$BOOTCD_VERSION-cramfs-serial.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 \
+    $tmp
+
+rm -rf $tmp
+trap - ERR INT
+
+# Create USB CRAMFS based image
+echo "* Creating USB CRAMFS based image"
+usb="$PLC_NAME-BootCD-$BOOTCD_VERSION-cramfs.usb"
+
+# leave 1MB of space on the USB VFAT
+let vfat_size=${cramfs_size}+2048
+
+# Make VFAT filesystem for USB
+mkfs.vfat -C "$usb" $vfat_size
+
+# Mount it
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+mount -o loop "$usb" $tmp
+trap "umount $tmp; rm -rf $tmp ${BUILDTMP}/cramfs.img" ERR INT
+
+# Populate it
+echo "* Populating USB with overlay images and cramfs"
+(cd $isofs && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
+cp ${BUILDTMP}/cramfs.img $tmp/
+
+# Use syslinux instead of isolinux to make the image bootable
+cat >$tmp/syslinux.cfg <<EOF
+TIMEOUT 120
+DISPLAY pl_version
+DEFAULT vga
+LABEL vga
+       KERNEL kernel
+       APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro
+EOF
+umount $tmp
+rmdir $tmp
+trap - ERR INT
+
+echo "* Making USB CRAMFS based image bootable"
+$srcdir/syslinux/unix/syslinux "$usb"
+
+# Create USB CRAMFS based image w/ serial line support
+echo "* Creating USB CRAMFS based image w/ serial line support"
+usb="$PLC_NAME-BootCD-$BOOTCD_VERSION-cramfs-serial.usb"
+
+# leave 4MB of space on the USB VFAT
+let vfat_size=${cramfs_size}+2048
+
+# Make VFAT filesystem for USB
+mkfs.vfat -C "$usb" $vfat_size
+
+# Mount it
+tmp=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
+mount -o loop "$usb" $tmp
+trap "umount $tmp; rm -rf $tmp ${BUILDTMP}/cramfs.img" ERR INT
+
+# Populate it
+echo "* Populating USB with overlay images and cramfs"
+(cd $isofs && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
+cp ${BUILDTMP}/cramfs.img $tmp/
+
+# Use syslinux instead of isolinux to make the image bootable
+cat >$tmp/syslinux.cfg <<EOF
+SERIAL 0 115200
+PROMPT 0
+TIMEOUT 120
+DISPLAY pl_version
+DEFAULT serial
+LABEL serial
+       KERNEL kernel
+       APPEND ramdisk_size=$cramfs_size initrd=cramfs.img root=/dev/ram0 ro  console=ttyS0,115200n8
+EOF
 umount $tmp
 rmdir $tmp
 trap - ERR INT
 
-echo "* Making USB image bootable"
+echo "* Making USB CRAMFS based image /w serial line support bootable"
 $srcdir/syslinux/unix/syslinux "$usb"
 
 exit 0