open early ssh access to myplc's debug key
[bootcd.git] / build.sh
1 #!/bin/bash
2 #
3 # Builds custom BootCD ISO and USB images in the current
4 # directory. 
5 #
6 # Aaron Klingaman <alk@absarokasoft.com>
7 # Mark Huang <mlhuang@cs.princeton.edu>
8 # Copyright (C) 2004-2007 The Trustees of Princeton University
9 #
10 # Jan 2015 - f21 comes with isolinux 6.03 (was 4.05 in f20)
11 # http://www.syslinux.org/wiki/index.php/ISOLINUX
12
13 COMMAND=$(basename $0)
14 DIRNAME=$(dirname $0)
15 PATH=/sbin:/bin:/usr/sbin:/usr/bin
16
17 # debugging flags
18 # keep KERNEL_DEBUG_ARGS void for production
19 KERNEL_DEBUG_ARGS=""
20 # add more flags here for debugging
21 # KERNEL_DEBUG_ARGS="$KERNEL_DEBUG_ARGS some_other_kernel_arg"
22 # see also
23 #  (*) GetBootMedium that has some provisions for common
24 #      kargs, like e.g. for removing the hangcheck feature,
25 #      or for turning on debug messages for systemd
26 #      these can be turned on with tags on the node
27 #  (*) tests default config, that uses this feature so
28 #      the tests can benefit these features, without deploying
29 #      them by default in production
30
31 # defaults
32 DEFAULT_TYPES="usb iso"
33 # Leave 4 MB of free space
34 GRAPHIC_CONSOLE="graphic"
35 SERIAL_CONSOLE="ttyS0:115200:n:8"
36 CONSOLE_INFO=$GRAPHIC_CONSOLE
37 MKISOFS_OPTS="-R -J -r -f -b isolinux.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table"
38 # isolinux-debug.bin is supposedly helpful as well if available,
39 # when things don't work as expected
40 #MKISOFS_OPTS="-R -J -r -f -b isolinux-debug.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table"
41
42 FREE_SPACE=4096
43
44 # command-line settable args
45 NODE_CONFIGURATION_FILE=
46 CUSTOM_DIR=
47 OUTPUT_BASE=
48 DRY_RUN=""
49 OUTPUT_NAME=""
50 TYPES=""
51 KERNEL_ARGS=""
52
53 # various globals
54 BUILDTMP=""
55 FULL_VERSION_STRING=""
56 ISOREF=""
57 ISOFS=""
58 OVERLAY=""
59 IS_SERIAL=""
60 console_dev=""
61 console_baud=""
62 console_spec=""
63 console_serial_line=""
64
65
66 #################### compute all supported types
67 # removing support for serial in the type
68 # this is because kargs.txt goes in the overlay, that is computed only once
69 # so we cannot handle serial and graphic modes within the same invokation of this script
70
71 ALL_TYPES=""
72 for x in iso usb usb_partition; do for c in "" "_cramfs" ; do
73   t="${x}${c}"
74   case $t in
75       usb_partition_cramfs)
76           # unsupported
77           ;;
78       *)
79           ALL_TYPES="$ALL_TYPES $t" ;;
80   esac
81 done; done
82
83 #################### cleanup utilities
84 declare -a _CLEANUPS=()
85 function do_cleanup() {
86     cd / ; for i in "${_CLEANUPS[@]}"; do $i ; done
87 }
88 function push_cleanup() {
89     _CLEANUPS=( "${_CLEANUPS[@]}" "$*" )
90 }
91 function pop_cleanup() {
92     unset _CLEANUPS[$((${#_CLEANUPS[@]} - 1))]
93 }
94
95 #################### initialization
96 function init_and_check () {
97
98     # Change to our source directory
99     local srcdir=$(cd $DIRNAME && pwd -P)
100     pushd $srcdir
101
102     # Root of the isofs
103     ISOREF=$PWD/${VARIANT}
104
105     # The reference image is expected to have been built by prep.sh (see .spec)
106     # we disable the initial logic that called prep.sh if that was not the case
107     # this is because prep.sh needs to know pldistro 
108     if [ ! -f $ISOREF/isofs/bootcd.img -o ! -f $ISOREF/version.txt ] ; then
109         echo "Could not find isofs and version.txt in $ISOREF"
110         if [ "$VARIANT" == "build" ] ; then
111             echo "You have to run prep.sh prior to calling $COMMAND"
112         else
113             echo "You need to create your variant image, see kvariant.sh"
114         fi
115         echo "Exiting .."
116         exit 1
117     fi
118
119     # build/version.txt written by prep.sh
120     BOOTCD_VERSION=$(cat ${VARIANT}/version.txt)
121
122     if [ -f /etc/planetlab/plc_config ] ; then
123         # Source PLC configuration
124         . /etc/planetlab/plc_config
125     fi
126
127     # use /var/tmp that should be large enough on both chroot- or vserver-based myplc
128     BUILDTMP=/var/tmp
129
130     FULL_VERSION_STRING="${PLC_NAME} BootCD ${BOOTCD_VERSION}"
131
132 }
133
134 # NOTE
135 # the custom-dir feature is designed to let a myplc try/ship a patched bootcd
136 # without the need for a full devel environment
137 # for example, you would create /root/custom-bootcd/etc/rc.d/init.d/pl_hwinit
138 # and run this script with -C /root/custom-bootcd
139 # this creates a third .img image of the custom dir, that 'hides' the files from 
140 # bootcd.img in the resulting unionfs
141 # it seems that this feature has not been used nor tested in a long time, use with care
142
143 usage() {
144     echo "Usage: $COMMAND [OPTION]..."
145     echo "    -f plnode.txt    Node to customize CD for (default: none)"
146     echo "    -t 'types'       Build the specified images (default: $DEFAULT_TYPES)"
147     echo "                     NOTE: mentioning 'serial' as part of the type is not supported anymore"
148     echo "    -a               Build all known types as listed below"
149     echo "    -s console-info  Enable a serial line as console and also bring up getty on that line"
150     echo "                     console-info: tty:baud-rate:parity:bits"
151     echo "                     or 'default' shortcut for $SERIAL_CONSOLE"
152     echo "    -S               equivalent to -s default"
153     echo "    -O output-base   The prefix of the generated files (default: PLC_NAME-BootCD-VERSION)"
154     echo "                     useful when multiple types are provided"
155     echo "                     can be a full path"
156     echo "    -o output-name   The full name of the generated file"
157     echo "    -C custom-dir    Custom directory"
158     echo "    -V variant       Use a variant - see kvariant.sh"
159     echo "    -n               Dry run - mostly for debug/test purposes"
160     echo "    -k               Add additional parameters to the kargs.txt file"
161     echo "    -h               This message"
162     echo "All known types: $ALL_TYPES"
163     exit 1
164 }
165
166 #################### 
167 function parse_command_line () {
168
169     # init
170     TYPES=""
171     # Get options
172     while getopts "f:t:as:SO:o:C:V:k:nh" opt ; do
173         case $opt in
174             f) NODE_CONFIGURATION_FILE=$OPTARG ;;
175             t) TYPES="$TYPES $OPTARG" ;;
176             a) TYPES="$ALL_TYPES" ;;
177             s) CONSOLE_INFO="$OPTARG" ;;
178             S) CONSOLE_INFO=$SERIAL_CONSOLE ;;
179             O) OUTPUT_BASE="$OPTARG" ;;
180             o) OUTPUT_NAME="$OPTARG" ;;
181             C) CUSTOM_DIR="$OPTARG" ;;
182             V) VARIANT="$OPTARG" ;;
183             k) KERNEL_ARGS="$KERNEL_ARGS $OPTARG" ;;
184             n) DRY_RUN=true ;;
185             h|*) usage ;;
186         esac
187     done
188
189     # use defaults if not set
190     [ -z "$TYPES" ] && TYPES="$DEFAULT_TYPES"
191     [ -z "$VARIANT" ] && VARIANT="build"
192     [ "$CONSOLE_INFO" == "default" ] && CONSOLE_INFO=$SERIAL_CONSOLE
193
194     if [ -n "$NODE_CONFIGURATION_FILE" ] ; then
195     # check existence of NODE_CONFIGURATION_FILE and normalize as we will change directory
196         if [ ! -f "$NODE_CONFIGURATION_FILE" ] ; then
197             echo "Node configuration file $NODE_CONFIGURATION_FILE not found - exiting"
198             exit 1
199         fi
200         cf_dir="$(dirname $NODE_CONFIGURATION_FILE)"
201         cf_dir="$(cd $cf_dir; pwd -P)"
202         cf_file="$(basename $NODE_CONFIGURATION_FILE)"
203         NODE_CONFIGURATION_FILE="$cf_dir"/"$cf_file"
204     fi
205
206     # check TYPES 
207     local matcher="XXX$(echo $ALL_TYPES | sed -e 's,\W,XXX,g')XXX"
208     for t in $TYPES; do
209         echo Checking type $t
210         echo $matcher | grep XXX${t}XXX &> /dev/null
211         if [ "$?" != 0 ] ; then
212             echo Unknown type $t
213             usage
214         fi
215     done
216
217 }
218
219 ####################
220 function init_serial () {
221     local console=$1; shift
222     if [ "$console" == "$GRAPHIC_CONSOLE" ] ; then
223         IS_SERIAL=
224         console_spec=""
225         echo "Standard, graphic, non-serial mode"
226     else
227         IS_SERIAL=true
228         console_dev=$(echo "$console" | awk -F: ' {print $1}')
229         console_baud=$(echo "$console" | awk -F: ' {print $2}')
230         [ -z "$console_baud" ] && console_baud="115200"
231         local console_parity=$(echo "$console" | awk -F: ' {print $3}')
232         [ -z "$console_parity" ] && console_parity="n"
233         local console_bits=$(echo "$console" | awk -F: ' {print $4}')
234         [ -z "$console_bits" ] && console_bits="8"
235         console_spec="console=${console_dev},${console_baud}${console_parity}${console_bits}"
236         local tty_nb=$(echo $console_dev | sed -e 's,[a-zA-Z],,g')
237         console_serial_line="SERIAL ${tty_nb} ${console_baud}"
238         echo "Serial mode"
239         echo "console_serial_line=${console_serial_line}"
240         echo "console_spec=${console_spec}"
241     fi
242 }
243
244 #################### run once : build the overlay image
245 function build_overlay () {
246
247     BUILDTMP=$(mktemp -d ${BUILDTMP}/bootcd.XXXXXX)
248     push_cleanup rm -fr "${BUILDTMP}"
249
250     # initialize ISOFS
251     ISOFS="${BUILDTMP}/isofs"
252     mkdir -p "$ISOFS"
253     for i in "$ISOREF"/isofs/{bootcd.img,kernel}; do
254         ln -s "$i" "$ISOFS"
255     done
256     # use new location as of fedora 12
257     # used to be in /usr/lib/syslinux/isolinux.bin
258     # removed backward compat in jan. 2015
259     # as of syslinux 6.05 (fedora 21) ldlinux.c32 is required by isolinux.bin
260     # the debug version can come in handy at times, and is 40k as well
261     isolinuxdir="/usr/share/syslinux"
262     # ship only what is mandatory, and forget about
263     # (*) isolinux-debug.bin as its name confuses mkisofs
264     # (*) memdisk that is not useful
265     isolinuxfiles="isolinux.bin ldlinux.c32"
266     for isolinuxfile in $isolinuxfiles; do
267         [ -f $isolinuxdir/$isolinuxfile ] && cp $isolinuxdir/$isolinuxfile "${BUILDTMP}/isofs"
268     done
269
270     # Root of the ISO and USB images
271     echo "* Populating root filesystem..."
272     OVERLAY="${BUILDTMP}/overlay"
273     install -d -m 755 $OVERLAY
274     push_cleanup rm -fr $OVERLAY
275
276     # Create version files
277     echo "* Creating version files"
278
279     # Boot Manager compares pl_version in both places to make sure that
280     # the right CD is mounted. We used to boot from an initrd and mount
281     # the CD on /usr. Now we just run everything out of the initrd.
282     for file in $OVERLAY/pl_version $OVERLAY/usr/isolinux/pl_version ; do
283         mkdir -p $(dirname $file)
284         echo "$FULL_VERSION_STRING" >$file
285     done
286
287     # Install boot server configuration files
288     echo "* Installing boot server configuration files"
289
290     # We always intended to bring up and support backup boot servers,
291     # but never got around to it. Just install the same parameters for
292     # both for now.
293     for dir in $OVERLAY/usr/boot $OVERLAY/usr/boot/backup ; do
294         install -D -m 644 $PLC_BOOT_CA_SSL_CRT $dir/cacert.pem
295         install -D -m 644 $PLC_ROOT_GPG_KEY_PUB $dir/pubring.gpg
296         echo "$PLC_BOOT_HOST" >$dir/boot_server
297         echo "$PLC_BOOT_SSL_PORT" >$dir/boot_server_port
298         echo "/boot/" >$dir/boot_server_path
299     done
300
301     # Install old-style boot server configuration files
302     # as opposed to what a former comment suggested, 
303     # this is still required, somewhere in the bootmanager apparently
304     install -D -m 644 $PLC_BOOT_CA_SSL_CRT $OVERLAY/usr/bootme/cacert/$PLC_BOOT_HOST/cacert.pem
305     echo "$FULL_VERSION_STRING" >$OVERLAY/usr/bootme/ID
306     echo "$PLC_BOOT_HOST" >$OVERLAY/usr/bootme/BOOTSERVER
307     echo "$PLC_BOOT_HOST" >$OVERLAY/usr/bootme/BOOTSERVER_IP
308     echo "$PLC_BOOT_SSL_PORT" >$OVERLAY/usr/bootme/BOOTPORT
309
310     # Generate /etc/issue
311     echo "* Generating /etc/issue"
312
313     if [ "$PLC_WWW_PORT" = "443" ] ; then
314         PLC_WWW_URL="https://$PLC_WWW_HOST/"
315     elif [ "$PLC_WWW_PORT" != "80" ] ; then
316         PLC_WWW_URL="http://$PLC_WWW_HOST:$PLC_WWW_PORT/"
317     else
318         PLC_WWW_URL="http://$PLC_WWW_HOST/"
319     fi
320
321     mkdir -p $OVERLAY/etc
322     cat >$OVERLAY/etc/issue <<EOF
323 $FULL_VERSION_STRING
324 $PLC_NAME Node: \n
325 Kernel \r on an \m
326 $PLC_WWW_URL
327
328 This machine is a node in the $PLC_NAME distributed network.  It has
329 not fully booted yet. If you have cancelled the boot process at the
330 request of $PLC_NAME Support, please follow the instructions provided
331 to you. Otherwise, please contact $PLC_MAIL_SUPPORT_ADDRESS.
332
333 Console login at this point is restricted to root. Provide the root
334 password of the default $PLC_NAME Central administrator account at the
335 time that this CD was created.
336
337 EOF
338     
339     # Set root password
340     echo "* Setting root password"
341
342     if [ -z "$ROOT_PASSWORD" ] ; then
343         # Generate an encrypted password with crypt() if not defined
344         # in a static configuration.
345         ROOT_PASSWORD=$(python <<EOF
346 import crypt, random, string
347 salt = [random.choice(string.letters + string.digits + "./") for i in range(0,8)]
348 print crypt.crypt('$PLC_ROOT_PASSWORD', '\$1\$' + "".join(salt) + '\$')
349 EOF
350 )
351     fi
352
353     # build/passwd copied out by prep.sh
354     sed -e "s@^root:[^:]*:\(.*\)@root:$ROOT_PASSWORD:\1@" ${VARIANT}/passwd >$OVERLAY/etc/passwd
355
356     # recent bootCDs rely on a standard systemd startup sequence
357     # so allow debug key to enter in this context whenever that makes sense
358     mkdir -p $OVERLAY/root/.ssh
359     chmod 700 $OVERLAY/root/.ssh
360     cp $PLC_DEBUG_SSH_KEY_PUB $OVERLAY/root/.ssh/authorized_keys
361     chmod 600 $OVERLAY/root/.ssh/authorized_keys
362
363     # Install node configuration file (e.g., if node has no floppy disk or USB slot)
364     if [ -f "$NODE_CONFIGURATION_FILE" ] ; then
365         echo "* Installing node configuration file $NODE_CONFIGURATION_FILE -> /usr/boot/plnode.txt of the bootcd image"
366         install -D -m 644 $NODE_CONFIGURATION_FILE $OVERLAY/usr/boot/plnode.txt
367         NODE_ID=$(source $NODE_CONFIGURATION_FILE; echo $NODE_ID)
368         echo "* Building network configuration for $NODE_ID"
369         plnet -- --root $OVERLAY --files-only --program BootCD $NODE_ID
370     fi
371
372     [ -n "$IS_SERIAL" ] && KERNEL_ARGS="$KERNEL_ARGS ${console_spec}"
373
374     # tmp: should be restricted to f15 nodes and above
375     # making sure the network interfaces are still numbered eth0 and above
376     KERNEL_ARGS="$KERNEL_ARGS biosdevname=0"
377     # making sure selinux is turned off - somehow this is needed with lxc/f14
378     KERNEL_ARGS="$KERNEL_ARGS selinux=0"
379     # add any debug flag if any (defined in the header of this script)
380     KERNEL_ARGS="$KERNEL_ARGS $KERNEL_DEBUG_ARGS"
381     # propagate kernel args for later boot stages
382     [ -n "$KERNEL_ARGS" ] && echo "$KERNEL_ARGS" > $OVERLAY/kargs.txt
383
384     # Pack overlay files into a compressed archive
385     echo "* Compressing overlay image"
386     (cd $OVERLAY && find . | cpio --quiet -c -o) | gzip -9 >$ISOFS/overlay.img
387
388     rm -rf $OVERLAY
389     pop_cleanup
390
391     if [ -n "$CUSTOM_DIR" ]; then
392         echo "* Compressing custom image"
393         (cd "$CUSTOM_DIR" && find . | cpio --quiet -c -o) | gzip -9 >$ISOFS/custom.img
394     fi
395
396     # Calculate ramdisk size (total uncompressed size of both archives)
397     ramdisk_size=$(gzip -l $ISOFS/bootcd.img $ISOFS/overlay.img ${CUSTOM_DIR:+$ISOFS/custom.img} | tail -1 | awk '{ print $2; }') # bytes
398     ramdisk_size=$((($ramdisk_size + 1023) / 1024)) # kilobytes
399
400     echo "$FULL_VERSION_STRING" >$ISOFS/pl_version
401
402     popd
403 }
404
405 #################### plain ISO
406 function build_iso() {
407     local iso="$1" ; shift
408     local custom="$1"
409
410     # Write isolinux configuration
411     cat >$ISOFS/isolinux.cfg <<EOF
412 ${console_serial_line}
413 PROMPT 0
414 DEFAULT planetlab-bootcd
415
416 LABEL planetlab-bootcd
417   DISPLAY pl_version
418   LINUX kernel
419   APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${KERNEL_ARGS}
420 EOF
421
422     # Create ISO image
423     echo "* Generated isolinux.cfg -------------------- BEG"
424     cat $ISOFS/isolinux.cfg
425     echo "* Generated isolinux.cfg -------------------- END"
426     echo "* Creating ISO image in pwd=$(pwd)"
427     echo "* with command mkisofs -o $iso $MKISOFS_OPTS $ISOFS"
428     mkisofs -o "$iso" $MKISOFS_OPTS $ISOFS
429 }
430
431 #################### USB with partitions
432 function build_usb_partition() {
433     echo -n "* Creating USB image with partitions..."
434     local usb="$1" ; shift
435     local custom="$1"
436
437     local size=$(($(du -Lsk $ISOFS | awk '{ print $1; }') + $FREE_SPACE))
438     size=$(( $size / 1024 ))
439
440     local heads=64
441     local sectors=32
442     local cylinders=$(( ($size*1024*2)/($heads*$sectors) ))
443     local offset=$(( $sectors*512 ))
444
445     if [ -f  /usr/lib/syslinux/mkdiskimage ] ; then
446         /usr/lib/syslinux/mkdiskimage -M -4 "$usb" $size $heads $sectors
447     else
448         mkdiskimage -M -4 "$usb" $size $heads $sectors
449     fi
450
451     cat >${BUILDTMP}/mtools.conf<<EOF
452 drive z:
453 file="${usb}"
454 cylinders=$cylinders
455 heads=$heads
456 sectors=$sectors
457 offset=$offset
458 mformat_only
459 mtools_skip_check=1
460 EOF
461     # environment variable for mtools
462     export MTOOLSRC="${BUILDTMP}/mtools.conf"
463
464     ### COPIED FROM build_usb() below!!!!
465     echo -n " populating USB image... "
466     mcopy -bsQ -i "$usb" "$ISOFS"/* z:/
467         
468     # Use syslinux instead of isolinux to make the image bootable
469     tmp="${BUILDTMP}/syslinux.cfg"
470     cat >$tmp <<EOF
471 ${console_serial_line}
472 PROMPT 0
473 DEFAULT planetlab-bootcd
474
475 LABEL planetlab-bootcd
476   DISPLAY pl_version
477   LINUX kernel
478   APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${KERNEL_ARGS}
479 EOF
480     mdel -i "$usb" z:/isolinux.cfg 2>/dev/null || :
481     mcopy -i "$usb" "$tmp" z:/syslinux.cfg
482     rm -f "$tmp"
483     rm -f "${MTOOLSRC}"
484     unset MTOOLSRC
485
486     echo "making USB image bootable."
487     syslinux -o $offset "$usb"
488
489 }
490
491 #################### plain USB
492 function build_usb() {
493     echo -n "* Creating USB image... "
494     local usb="$1" ; shift
495     local custom="$1"
496
497     rm -f "$usb"
498     mkfs.vfat -C "$usb" $(($(du -Lsk $ISOFS | awk '{ print $1; }') + $FREE_SPACE))
499
500     cat >${BUILDTMP}/mtools.conf<<EOF
501 mtools_skip_check=1
502 EOF
503     # environment variable for mtools
504     export MTOOLSRC="${BUILDTMP}/mtools.conf"
505
506     # Populate it
507     echo -n " populating USB image... "
508     mcopy -bsQ -i "$usb" "$ISOFS"/* ::/
509
510     # Use syslinux instead of isolinux to make the image bootable
511     tmp="${BUILDTMP}/syslinux.cfg"
512     cat >$tmp <<EOF
513 ${console_serial_line}
514 PROMPT 0
515 DEFAULT planetlab-bootcd
516
517 LABEL planetlab-bootcd
518   DISPLAY pl_version
519   LINUX kernel
520   APPEND ramdisk_size=$ramdisk_size initrd=bootcd.img,overlay.img${custom:+,custom.img} root=/dev/ram0 rw ${KERNEL_ARGS}
521 EOF
522     mdel -i "$usb" ::/isolinux.cfg 2>/dev/null || :
523     mcopy -i "$usb" "$tmp" ::/syslinux.cfg
524     rm -f "$tmp"
525     rm -f "${MTOOLSRC}"
526     unset MTOOLSRC
527
528     echo "making USB image bootable."
529     syslinux "$usb"
530 }
531
532 #################### utility to setup CRAMFS related support
533 function prepare_cramfs() {
534     [ -n "$CRAMFS_PREPARED" ] && return 0
535     local custom=$1; 
536
537     echo "* Setting up CRAMFS-based images"
538     local tmp="${BUILDTMP}/cramfs-tree"
539     mkdir -p "$tmp"
540     push_cleanup rm -rf $tmp
541     pushd $tmp
542     gzip -d -c $ISOFS/bootcd.img     | cpio -diu
543     gzip -d -c $ISOFS/overlay.img    | cpio -diu
544     [ -n "$custom" ] && \
545         gzip -d -c $ISOFS/custom.img | cpio -diu
546
547     # clean out unnecessary rpm lib
548     echo "* clearing var/lib/rpm/*"
549     rm -f var/lib/rpm/*
550
551     # bootcd requires this directory
552     mkdir -p mnt/confdevice
553
554     # relocate various directory to /tmp
555     rm -rf root
556     ln -fs /tmp/root root
557     ln -fs /sbin/init linuxrc 
558     ln -fs /tmp/resolv.conf etc/resolv.conf
559     ln -fs /tmp/etc/mtab etc/mtab
560
561     # have pl_rsysinit copy over appropriate etc & var directories into /tmp/etc/
562     # make /tmp/etc
563     echo "* renaming dirs in ./etc"
564     pushd etc
565     for dir in `find * -type d -prune | grep -v rc.d`; do
566         mv ${dir} ${dir}_o
567         ln -fs /tmp/etc/${dir} ${dir}
568     done
569     popd
570
571     echo "* renaming dirs in ./var"
572     # rename all top-level directories and put in a symlink to /tmp/var
573     pushd var
574     for dir in `find * -type d -prune`; do
575         mv ${dir} ${dir}_o
576         ln -fs /tmp/var/${dir} ${dir}
577     done
578     popd
579
580     # overwrite fstab to mount / as cramfs and /tmp as tmpfs
581     echo "* Overwriting etc/fstab to use cramfs and tmpfs"
582     rm -f ./etc/fstab
583     cat >./etc/fstab <<EOF
584 /dev/ram0     /              cramfs     ro              0 0
585 none          /dev/pts       devpts     gid=5,mode=620  0 0
586 none          /proc          proc       defaults        0 0
587 none          /sys           sysfs      defaults        0 0
588 EOF
589
590     pushd dev
591     rm -f console
592     mknod console c 5 1
593     #for i in 0 1 2 3 4 5 6 7 8; do rm -f ram${i} ; done
594     #for i in 0 1 2 3 4 5 6 7 8; do mknod ram${i} b 1 ${i} ; done
595     #ln -fs ram1 ram
596     #ln -fs ram0 ramdisk
597     popd
598
599     # update etc/inittab to start with pl_rsysinit
600     for file in etc/inittab etc/event.d/rcS etc/init/rcS.conf; do
601         [ -f $file ] && sed -i 's,pl_sysinit,pl_rsysinit,' $file
602     done
603
604     # modify inittab to have a serial console
605     # xxx this might well be broken with f12 and above xxx
606     if [ -n "$serial" ] ; then
607         echo "T0:23:respawn:/sbin/agetty -L $console_dev $console_baud vt100" >> etc/inittab
608         # and let root log in
609         echo "$console_dev" >> etc/securetty
610     fi
611
612     # calculate the size of /tmp based on the size of /etc & /var + 8MB slack
613     etcsize=$(du -s ./etc | awk '{ print $1 }')
614     varsize=$(du -s ./var | awk '{ print $1 }')
615     let msize=($varsize+$etcsize+8192)/1024
616
617     # make dhclient happy
618     for i in $(seq 0 9); do ln -fs /tmp/etc/dhclient-eth${i}.conf etc/dhclient-eth${i}.conf ; done
619     ln -fs /tmp/etc/resolv.conf etc/resolv.conf
620     ln -fs /tmp/etc/resolv.conf.predhclient etc/resolv.conf.predhclient
621
622     # generate pl_rsysinit
623     cat > etc/rc.d/init.d/pl_rsysinit <<EOF
624 #!/bin/sh
625 # generated by $COMMAND
626 echo -n "pl_rsysinit: preparing /etc and /var for pl_sysinit..."
627 mount -t tmpfs -orw,size=${msize}M,mode=1777 tmpfs /tmp
628 mkdir -p /tmp/root
629 mkdir -p /tmp/etc
630 touch /tmp/etc/resolv.conf
631 touch /tmp/etc/mtab
632 mkdir -p /tmp/var
633
634 # make mtab happy
635 echo "tmpfs /tmp tmpfs rw,size=${msize}M,mode=1777 1 1" > /tmp/etc/mtab
636
637 # copy over directory contents of all _o directories from /etc and /var
638 # /tmp/etc and /tmp/var
639 pushd /etc
640 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
641 popd
642 pushd /var
643 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
644 popd
645
646 echo "done"
647
648 # hand over to pl_sysinit
649 echo "pl_rsysinit: handing over to pl_sysinit"
650 /etc/init.d/pl_sysinit
651 EOF
652     chmod +x etc/rc.d/init.d/pl_rsysinit
653
654     popd
655
656     # create the cramfs image
657     echo "* Creating cramfs image"
658     mkfs.cramfs $tmp/ ${BUILDTMP}/cramfs.img
659     cramfs_size=$(($(du -sk ${BUILDTMP}/cramfs.img | awk '{ print $1; }') + 1))
660     rm -rf $tmp
661     pop_cleanup
662 }
663
664 #################### Create ISO CRAMFS image
665 function build_iso_cramfs() {
666     local iso="$1" ; shift
667     local custom="$1"
668
669     prepare_cramfs "$custom"
670     echo "* Creating ISO CRAMFS-based image"
671
672     local tmp="${BUILDTMP}/cramfs-iso"
673     mkdir -p "$tmp"
674     push_cleanup rm -rf $tmp
675     (cd $ISOFS && find . | grep -v "\.img$" | cpio -p -d -u $tmp/)
676     cat >$tmp/isolinux.cfg <<EOF
677 ${console_serial_line}
678 PROMPT 0
679 DEFAULT planetlab-bootcd
680
681 LABEL planetlab-bootcd
682   DISPLAY pl_version
683   LINUX kernel
684   APPEND ramdisk_size=$ramdisk_size initrd=cramfs.img root=/dev/ram0 rw ${KERNEL_ARGS}
685 EOF
686
687     cp ${BUILDTMP}/cramfs.img $tmp
688     mkisofs -o "$iso" \
689         $MKISOFS_OPTS \
690         $tmp
691
692     rm -fr "$tmp"
693     pop_cleanup
694 }
695
696 #################### Create USB CRAMFS based image
697 function build_usb_cramfs() {
698     local usb="$1" ; shift
699     local custom="$1"
700
701     prepare_cramfs "$custom"
702     echo "* Creating USB CRAMFS based image"
703
704     let vfat_size=${cramfs_size}+$FREE_SPACE
705
706     # Make VFAT filesystem for USB
707     mkfs.vfat -C "$usb" $vfat_size
708
709     # Populate it
710     echo "* Populating USB with overlay images and cramfs"
711     mcopy -bsQ -i "$usb" $ISOFS/kernel $ISOFS/pl_version ::/
712     mcopy -bsQ -i "$usb" ${BUILDTMP}/cramfs.img ::/
713
714     # Use syslinux instead of isolinux to make the image bootable
715     tmp="${BUILDTMP}/syslinux.cfg"
716     cat >$tmp <<EOF
717 ${console_serial_line}
718 PROMPT 0
719 DEFAULT planetlab-bootcd
720
721 LABEL planetlab-bootcd
722   DISPLAY pl_version
723   LINUX kernel
724   APPEND ramdisk_size=$ramdisk_size initrd=cramfs.img root=/dev/ram0 rw ${KERNEL_ARGS}
725 EOF
726
727     mcopy -bsQ -i "$usb" "$tmp" ::/syslinux.cfg
728     rm -f "$tmp"
729
730     echo "* Making USB CRAMFS based image bootable"
731     syslinux "$usb"
732 }
733
734 #################### map on all types provided on the command-line and invoke one of the above functions
735 function build_types () {
736
737     [ -z "$OUTPUT_BASE" ] && OUTPUT_BASE="$PLC_NAME-BootCD-$BOOTCD_VERSION"
738
739     # alter output filename to reflect serial settings
740     if [ -n "$IS_SERIAL" ] ; then
741         if [ "$CONSOLE_INFO" == "$SERIAL_CONSOLE" ] ; then
742             serial="-serial"
743         else
744             serial="-serial-$(echo $CONSOLE_INFO | sed -e 's,:,,g')"
745         fi
746     else
747         serial=""
748     fi
749     
750     function type_to_name() {
751         echo $1 | sed '
752         s/usb$/.usb/;
753         s/usb_partition$/-partition.usb/;
754         s/iso$/.iso/;
755         s/usb_cramfs$/-cramfs.usb/;
756         s/iso_cramfs$/-cramfs.iso/;
757         '
758     }
759
760     for t in $TYPES; do
761         arg=$t
762
763         tname=`type_to_name $t`
764         # if -o is specified (as it has no default)
765         if [ -n "$OUTPUT_NAME" ] ; then
766             output=$OUTPUT_NAME
767         else
768             output="${OUTPUT_BASE}${serial}${tname}"
769         fi
770
771         echo "*** Dealing with type=$arg"
772         echo '*' build_$t "$output" "$CUSTOM_DIR"
773         [ -n "$DRY_RUN" ] || build_$t "$output" "$CUSTOM_DIR" 
774     done
775 }
776
777 #################### 
778 function main () {
779
780     parse_command_line "$@"
781
782     init_and_check
783
784     echo "* Building bootcd images for $NODE_CONFIGURATION_FILE ($FULL_VERSION_STRING) - $(date +%H-%M:%S)"
785     # Do not tolerate errors
786     set -e
787     trap "do_cleanup" ERR INT EXIT
788
789     init_serial $CONSOLE_INFO
790     build_overlay
791     build_types
792
793     echo "* Done with bootcd images for $NODE_CONFIGURATION_FILE - $(date +%H-%M:%S)"
794     exit 0
795 }
796
797 ####################
798 main "$@"