scripts/casper

   1 #!/bin/sh
   2
   3 # set -e
   4
   5 export PATH=/root/usr/bin:/root/usr/sbin:/root/bin:/root/sbin:/usr/bin:/usr/sbin:/bin:/sbin
   6
   7 mountpoint=/live_media
   8
   9 root_persistence="casper-rw"
  10 home_persistence="home-rw"
  11 root_snapshot_label="casper-sn"
  12 home_snapshot_label="home-sn"
  13
  14 USERNAME="casper"
  15 USERFULLNAME="Live session user"
  16 HOSTNAME="live"
  17 BUILD_SYSTEM="Debian"
  18
  19 mkdir -p $mountpoint
  20
  21 [ -f /etc/casper.conf ] && . /etc/casper.conf
  22 export USERNAME USERFULLNAME HOSTNAME BUILD_SYSTEM
  23
  24 . /scripts/casper-helpers
  25
  26 parse_cmdline ()
  27 {
  28     # looking for casper specifics options as kernel parameters
  29     for x in $(cat /proc/cmdline); do
  30         case $x in
  31             userfullname=*)
  32                 export USERFULLNAME=${x#userfullname=}
  33                 export CASPERCONF="changed"
  34                 ;;
  35             hostname=*)
  36                 export HOSTNAME=${x#hostname=}
  37                 export CASPERCONF="changed"
  38                 ;;
  39             username=*)
  40                 export USERNAME=${x#username=}
  41                 export CASPERCONF="changed"
  42                 ;;
  43             netboot*)
  44                 export NETBOOT=${x#netboot=} ;;
  45             toram)
  46                 export TORAM=1 ;;
  47             todisk=*)
  48                 export TODISK=${x#todisk=} ;;
  49             showmounts)
  50                 export SHOWMOUNTS=1 ;;
  51             persistent)
  52                 export PERSISTENT=1 ;;
  53             ip*)
  54                 STATICIP=${x#ip=}
  55                 if [ "${STATICIP}" == "" ]; then
  56                     STATICIP="frommedia"
  57                 fi
  58                 export STATICIP ;;
  59             casper-getty)
  60                 export CASPERGETTY=1 ;;
  61             console=*)
  62                 export DEFCONSOLE=$(sed -e 's%.*console=%console=%' /proc/cmdline) ;;
  63             bootfrom=*)
  64                 export LIVEMEDIA=${x#bootfrom=} ;;
  65             live-media=*)
  66                 export LIVEMEDIA=${x#live-media=} ;;
  67             debian-installer/locale=*)
  68                 export LOCALE=${x#debian-installer/locale=} ;;
  69             locale=*)
  70                 export LOCALE=${x#locale=} ;;
  71             kbd-chooser/method=*)
  72                 export KBD=${x#kbd-chooser/method=} ;;
  73             keyb=*)
  74                 export KBD=${x#keyb=} ;;
  75             console-setup/layoutcode=*)
  76                 export CSLAYOUT=${x#console-setup/layoutcode=} ;;
  77             console-setup/variantcode=*)
  78                 export CSVARIANT=${x#console-setup/variantcode=} ;;
  79             console-setup/modelcode=*)
  80                 export CSMODEL=${x#console-setup/modelcode=} ;;
  81         esac
  82     done
  83
  84     # sort of compatibility with netboot.h from linux docs
  85     if [ -z "${NETBOOT}" ]; then
  86         if [ "${ROOT}" == "/dev/nfs" ]; then
  87             NETBOOT="nfs"
  88             export NETBOOT
  89         elif [ "${ROOT}" == "/dev/cifs" ]; then
  90             NETBOOT="cifs"
  91             export NETBOOT
  92         fi
  93     fi
  94 }
  95
  96 is_casper_path() {
  97     path=$1
  98     if [ -d "$path/casper" ]; then
  99         if [ "$(echo $path/casper/*.squashfs)" != "$path/casper/*.squashfs" ] ||
 100             [ "$(echo $path/casper/*.ext2)" != "$path/casper/*.ext2" ] ||
 101             [ "$(echo $path/casper/*.dir)" != "$path/casper/*.dir" ]; then
 102             return 0
 103         fi
 104     fi
 105     return 1
 106 }
 107
 108 get_backing_device() {
 109     case "$1" in
 110         *.squashfs|*.ext2)
 111             echo $(setup_loop "$1" "loop" "/sys/block/loop*")
 112             ;;
 113         *.dir)
 114             echo "directory"
 115             ;;
 116         *)
 117             panic "Unrecognized casper filesystem: $1"
 118             ;;
 119     esac
 120 }
 121
 122 match_files_in_dir() {
 123     # Does any files match pattern $1 ?
 124
 125     local pattern="$1"
 126     if [ "$(echo $pattern)" != "$pattern" ]; then
 127         return 0
 128     fi
 129     return 1
 130 }
 131
 132 mount_images_in_directory() {
 133     directory="$1"
 134     rootmnt="$2"
 135     if match_files_in_dir "$directory/casper/*.squashfs" ||
 136         match_files_in_dir "$directory/casper/*.ext2" ||
 137         match_files_in_dir "$directory/casper/*.dir"; then
 138         setup_unionfs "$directory/casper" "$rootmnt"
 139     else
 140         :
 141     fi
 142 }
 143
 144 is_nice_device() {
 145     sysfs_path="${1#/sys}"
 146     if /lib/udev/path_id "${sysfs_path}" | grep -E -q "ID_PATH=(usb|pci-[^-]*-[ide|scsi|usb])"; then
 147         return 0
 148     fi
 149     return 1
 150 }
 151
 152 is_supported_fs ()
 153 {
 154     # FIXME: do something better like the scan of supported filesystems
 155     fstype="${1}"
 156     case ${fstype} in
 157         vfat|iso9660|udf|ext2|ext3|ntfs)
 158             return 0
 159             ;;
 160     esac
 161     return 1
 162 }
 163
 164 copy_live_to() {
 165     copyfrom="${1}"
 166     copytodev="${2}"
 167     copyto="${copyfrom}_swap"
 168
 169     size=$(fs_size "" ${copyfrom} "used")
 170
 171     if [ "${copytodev}" = "ram" ]; then
 172         # copying to ram:
 173         freespace=$( expr $(awk '/MemFree/{print $2}' /proc/meminfo) + $( cat /proc/meminfo | grep Cached | head -n 1 | awk '/Cached/{print $2}' - ) )
 174         mount_options="-o size=${size}k"
 175         free_string="memory"
 176         fstype="tmpfs"
 177         dev="/dev/shm"
 178     else
 179         # it should be a writable block device
 180         if [ -b "${copytodev}" ]; then
 181             dev="${copytodev}"
 182             free_string="space"
 183             fstype=$(get_fstype "${dev}")
 184             freespace=$(fs_size "${dev}")
 185         else
 186             [ "$quiet" != "y" ] && log_warning_msg "${copytodev} is not a block device."
 187             return 1
 188         fi
 189     fi
 190     if [ "${freespace}" -lt "${size}" ] ; then
 191         [ "$quiet" != "y" ] && log_warning_msg "Not enough free ${free_string} (${freespace}k > ${size}k) to copy live media in ${copytodev}."
 192         return 1
 193     fi
 194
 195     # begin copying..
 196     mkdir "${copyto}"
 197     echo "mount -t ${fstype} ${mount_options} ${dev} ${copyto}"
 198     mount -t "${fstype}" ${mount_options} "${dev}" "${copyto}"
 199     cp -a ${copyfrom}/* ${copyto} # "cp -a" from busybox also copies hidden files
 200     umount ${copyfrom}
 201     mount -r -o move ${copyto} ${copyfrom}
 202     rmdir ${copyto}
 203     return 0
 204 }
 205
 206 do_netmount() {
 207     rc=1
 208
 209     modprobe "${MP_QUIET}" af_packet # For DHCP
 210
 211     ipconfig ${DEVICE} /tmp/net-${DEVICE}.conf
 212
 213     if [ "${NFSROOT}" = "auto" ]; then
 214         NFSROOT=${ROOTSERVER}:${ROOTPATH}
 215     fi
 216
 217     [ "$quiet" != "y" ] && log_begin_msg "Trying netboot from ${NFSROOT}"
 218
 219     if [ "${NETBOOT}" != "nfs" ] && do_cifsmount ; then
 220         rc=0
 221     elif do_nfsmount ; then
 222         NETBOOT="nfs"
 223         export NETBOOT
 224         rc=0
 225     fi
 226
 227     [ "$quiet" != "y" ] && log_end_msg
 228     return ${rc}
 229 }
 230
 231 do_nfsmount() {
 232     rc=1
 233     modprobe "${MP_QUIET}" nfs
 234     if [ -z "${NFSOPTS}" ]; then
 235         NFSOPTS=""
 236     fi
 237
 238     [ "$quiet" != "y" ] && log_begin_msg "Trying nfsmount -o nolock -o ro ${NFSOPTS} ${NFSROOT} ${mountpoint}"
 239     # FIXME: This for loop is an ugly HACK round an nfs bug
 240     for i in 0 1 2 3 4 5 6 7 8 9 a b c d e f 10 11 12 13; do
 241         nfsmount -o nolock -o ro ${NFSOPTS} "${NFSROOT}" "${mountpoint}" && rc=0 && break
 242         sleep 1
 243     done
 244     return ${rc}
 245 }
 246
 247 do_cifsmount() {
 248     rc=1
 249     if [ -x "/sbin/mount.cifs" ]; then
 250         if [ -z "${NFSOPTS}" ]; then
 251             CIFSOPTS="-ouser=root,password="
 252         else
 253             CIFSOPTS="${NFSOPTS}"
 254         fi
 255
 256         [ "$quiet" != "y" ] && log_begin_msg "Trying mount.cifs ${NFSROOT} ${mountpoint} ${CIFSOPTS}"
 257         modprobe "${MP_QUIET}" cifs
 258
 259         if mount.cifs "${NFSROOT}" "${mountpoint}" "${CIFSOPTS}" ; then
 260             rc=0
 261         fi
 262     fi
 263     return ${rc}
 264 }
 265
 266 do_snap_copy ()
 267 {
 268     fromdev="${1}"
 269     todir="${2}"
 270     snap_type="${3}"
 271
 272     size=$(fs_size "${fromdev}" "" "used")
 273
 274     if [ -b "${fromdev}" ]; then
 275         # look for free mem
 276         if [ -n "${HOMEMOUNTED}" -a "${snap_type}" = "HOME" ]; then
 277             todev=$(cat /proc/mounts | grep -s " $(base_path ${todir}) " | awk '{print $1}' )
 278             freespace=$(df -k  | grep -s ${todev} | awk '{print $4}')
 279         else
 280             freespace=$( expr $(awk '/MemFree/{print $2}' /proc/meminfo) + $( cat /proc/meminfo | grep Cached | head -n 1 | awk '/Cached/{print $2}' - ))
 281         fi
 282
 283         tomount="/mnt/tmpsnap"
 284         if [ ! -d "${tomount}" ] ; then
 285             mkdir -p "${tomount}"
 286         fi
 287
 288         fstype=$(get_fstype "${fromdev}")
 289         if [ -n "${fstype}" ]; then
 290             # Copying stuff...
 291             mount -t "${fstype}" -o ro "${fromdev}" "${tomount}"
 292             cp -a "${tomount}"/* ${todir}
 293             umount "${tomount}"
 294         else
 295             log_warning_msg "Unrecognized fstype: ${fstype} on ${fromdev}:${snap_type}"
 296         fi
 297
 298         rmdir "${tomount}"
 299         if echo ${fromdev} | grep -qs loop; then
 300            losetup -d "${fromdev}"
 301         fi
 302         return 0
 303     else
 304         return 1
 305         [ "$quiet" != "y" ] && log_warning_msg "Unable to find the snapshot ${snap_type} medium"
 306     fi
 307 }
 308
 309 try_snap ()
 310 {
 311     # Look for $snap_label.* in block devices and copy the contents to $snap_mount
 312     #   and remember the device and filename for resync on exit in casper.init
 313
 314     snap_label="${1}"
 315     snap_mount="${2}"
 316     snap_type="${3}"
 317
 318     snapdata=$(find_files "${snap_label}.squashfs ${snap_label}.cpio.gz ${snap_label}.ext2")
 319     if [ ! -z "${snapdata}" ]; then
 320         snapdev="$(echo ${snapdata} | cut -f1 -d ' ')"
 321         snapback="$(echo ${snapdata} | cut -f2 -d ' ')"
 322         snapfile="$(echo ${snapdata} | cut -f3 -d ' ')"
 323         if echo "${snapfile}" | grep -qs '\(squashfs\|ext2\)'; then
 324             # squashfs or ext2 snapshot
 325             dev=$(get_backing_device "${snapback}/${snapfile}")
 326             if ! do_snap_copy "${dev}" "${snap_mount}" "${snap_type}"; then
 327                  log_warning_msg "Impossible to include the ${snapfile} Snapshot"
 328                  return 1
 329             fi
 330         else
 331             # cpio.gz snapshot
 332             if ! (cd "${snap_mount}" && zcat "${snapback}/${snapfile}" | cpio -i -u -d 2>/dev/null) ; then
 333                 log_warning_msg "Impossible to include the ${snapfile} Snapshot"
 334                 return 1
 335             fi
 336         fi
 337         umount "${snapback}"
 338     else
 339         dev=$(find_cow_device "${snap_label}")
 340         if [ -b ${dev} ]; then
 341             if echo "${dev}" | grep -qs loop; then
 342                 # strange things happens, user confused?
 343                 snaploop=$( losetup ${dev} | awk '{print $3}' | tr -d '()' )
 344                 snapfile=$(basename ${snaploop})
 345                 snapdev=$(cat /proc/mounts | awk '{print $2,$1}' | grep -es "^$( dirname ${snaploop} )" | cut -f2 -d ' ')
 346             else
 347                 snapdev="${dev}"
 348             fi
 349             if ! do_snap_copy "${dev}" "${snap_mount}" "${snap_type}" ; then
 350                 log_warning_msg "Impossible to include the ${snap_label} Snapshot"
 351                 return 1
 352             else
 353                 if [ -n "${snapfile}" ]; then
 354                      # it was a loop device, user confused
 355                      umount ${snapdev}
 356                 fi
 357             fi
 358         else
 359             log_warning_msg "Impossible to include the ${snap_label} Snapshot"
 360             return 1
 361         fi
 362     fi
 363     echo "export ${snap_type}SNAP="${snap_mount}":${snapdev}:${snapfile}" >> /etc/casper.conf # for resync on reboot/halt
 364     return 0
 365 }
 366
 367 setup_unionfs() {
 368     image_directory="$1"
 369     rootmnt="$2"
 370
 371     modprobe "${MP_QUIET}" -b unionfs
 372
 373     # run-init can't deal with images in a subdir, but we're going to
 374     # move all of these away before it runs anyway.  No, we're not,
 375     # put them in / since move-mounting them into / breaks mono and
 376     # some other apps.
 377
 378     croot="/"
 379
 380     # Let's just mount the read-only file systems first
 381     rofsstring=""
 382     rofslist=""
 383     if [ "${NETBOOT}" == "nfs" ] ; then
 384         roopt="nfsro" # go aroung a bug in nfs-unionfs locking
 385     else
 386         roopt="ro"
 387     fi
 388
 389     mkdir -p "${croot}"
 390     for image_type in "ext2" "squashfs" "dir" ; do
 391         for image in "${image_directory}"/*."${image_type}"; do
 392             imagename=$(basename "${image}")
 393             if [ -d "${image}" ]; then
 394                 # it is a plain directory: do nothing
 395                 rofsstring="${image}=${roopt}:${rofsstring}"
 396                 rofslist="${image} ${rofslist}"
 397             elif [ -f "${image}" ]; then
 398                 backdev=$(get_backing_device "$image")
 399                 fstype=$(get_fstype "${backdev}")
 400                 if [ "${fstype}" = "unknown" ]; then
 401                     panic "Unknown file system type on ${backdev} (${image})"
 402                 fi
 403                 mkdir -p "${croot}/${imagename}"
 404                 mount -t "${fstype}" -o ro "${backdev}" "${croot}/${imagename}" || panic "Can not mount $backdev ($image) on ${croot}/${imagename}" && rofsstring="${croot}/${imagename}=${roopt}:${rofsstring}" && rofslist="${croot}/${imagename} ${rofslist}"
 405             fi
 406         done
 407     done
 408     rofsstring=${rofsstring%:}
 409
 410     mkdir -p /cow
 411     cowdevice="tmpfs"
 412     cow_fstype="tmpfs"
 413
 414     # Looking for "${root_persistence}" device or file
 415     if [ -n "${PERSISTENT}" ]; then
 416         cowprobe=$(find_cow_device "${root_persistence}")
 417         if [ -b "${cowprobe}" ]; then
 418             cowdevice=${cowprobe}
 419             cow_fstype=$(get_fstype "${cowprobe}")
 420         else
 421             [ "$quiet" != "y" ] && log_warning_msg "Unable to find the persistent medium"
 422         fi
 423     fi
 424
 425     mount ${cowdevice} -t ${cow_fstype} -o rw /cow || panic "Can not mount $cowdevice on /cow"
 426
 427     mount -t unionfs -o dirs=/cow=rw:$rofsstring unionfs "$rootmnt" || panic "Unionfs mount failed"
 428
 429     # Adding other custom mounts
 430     if [ -n "${PERSISTENT}" ]; then
 431         # directly mount /home
 432         # FIXME: add a custom mounts configurable system
 433         homecow=$(find_cow_device "${home_persistence}" )
 434         if [ -b "${homecow}" ]; then
 435             mount -t $(get_fstype "${homecow}") -o rw "${homecow}" "${rootmnt}/home"
 436             export HOMEMOUNTED=1 # used to proper calculate free space in do_snap_copy()
 437         else
 438             [ "$quiet" != "y" ] && log_warning_msg "Unable to find the persistent home medium"
 439         fi
 440         # Look for other snapshots to copy in
 441         try_snap "${root_snapshot_label}" "${rootmnt}" "ROOT"
 442         try_snap "${home_snapshot_label}" "${rootmnt}/home" "HOME"
 443     fi
 444
 445     if [ -n "${SHOWMOUNTS}" ]; then
 446         for d in ${rofslist}; do
 447             mkdir -p "${rootmnt}/casper/${d##*/}"
 448             case d in
 449                 *.dir) # do nothing # mount -o bind "${d}" "${rootmnt}/casper/${d##*/}"
 450                     ;;
 451                 *) mount -o move "${d}" "${rootmnt}/casper/${d##*/}"
 452                     ;;
 453             esac
 454         done
 455     fi
 456
 457     # shows cow fs on /cow for use by casper-snapshot
 458     mkdir -p "${rootmnt}/cow"
 459     mount -o bind /cow "${rootmnt}/cow"
 460 }
 461
 462 check_dev ()
 463 {
 464     sysdev="${1}"
 465     devname="${2}"
 466     if [ -z "${devname}" ]; then
 467         devname=$(sys2dev "${sysdev}")
 468     fi
 469     fstype=$(get_fstype "${devname}")
 470     if is_supported_fs ${fstype}; then
 471         mount -t ${fstype} -o ro "${devname}" $mountpoint || continue
 472         if is_casper_path $mountpoint; then
 473             echo $mountpoint
 474             return 0
 475         else
 476             umount $mountpoint
 477         fi
 478     fi
 479     return 1
 480 }
 481
 482 find_livefs() {
 483     # first look at the one specified in the command line
 484     if [ ! -z "${LIVEMEDIA}" ]; then
 485         if check_dev "null" "${LIVEMEDIA}"; then
 486             return 0
 487         fi
 488     fi
 489     # or do the scan of block devices
 490     for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -v loop | grep -v ram); do
 491         devname=$(sys2dev "${sysblock}")
 492         fstype=$(get_fstype "${devname}")
 493         if /lib/udev/cdrom_id ${devname} > /dev/null; then
 494             if check_dev "null" "${devname}" ; then
 495                 return 0
 496             fi
 497         elif is_nice_device "${sysblock}" ; then
 498             for dev in $(subdevices "${sysblock}"); do
 499                 if check_dev "${dev}" ; then
 500                     return 0
 501                 fi
 502             done
 503         elif [ "${fstype}" = "squashfs" -o \
 504                 "${fstype}" = "ext3" ] -o \
 505                 "${fstype}" = "ext2" ]; then
 506             # This is an ugly hack situation, the block device has
 507             # an image directly on it.  It's hopefully
 508             # casper, so take it and run with it.
 509             ln -s "${devname}" "${devname}.${fstype}"
 510             echo "${devname}.${fstype}"
 511             return 0
 512         fi
 513     done
 514     return 1
 515 }
 516
 517 pulsate() {
 518     if [ -x /sbin/usplash_write ]; then
 519         /sbin/usplash_write "PULSATE"
 520     fi
 521 }
 522
 523 set_usplash_timeout() {
 524     if [ -x /sbin/usplash_write ]; then
 525         /sbin/usplash_write "TIMEOUT 120"
 526     fi
 527 }
 528
 529 mountroot() {
 530     exec 6>&1
 531     exec 7>&2
 532     exec > casper.log
 533     exec 2>&1
 534
 535     parse_cmdline
 536
 537     set_usplash_timeout
 538     [ "$quiet" != "y" ] && log_begin_msg "Running /scripts/casper-premount"
 539     pulsate
 540     run_scripts /scripts/casper-premount
 541     [ "$quiet" != "y" ] && log_end_msg
 542
 543     # Needed here too because some things (*cough* udev *cough*)
 544     # changes the timeout
 545
 546     set_usplash_timeout
 547
 548     if [ ! -z "${NETBOOT}" ]; then
 549         if do_netmount ; then
 550             livefs_root="${mountpoint}"
 551         else
 552             panic "Unable to find a the network rootfs live file system"
 553         fi
 554     else
 555         # Scan local devices for the image
 556         for i in 0 1 2 3 4 5 6 7 8 9 a b c d e f 10 11 12 13; do
 557             livefs_root=$(find_livefs)
 558             if [ ! -z "${livefs_root}" ]; then
 559                 break
 560             fi
 561             sleep 1
 562         done
 563     fi
 564
 565     if [ -z "${livefs_root}" ]; then
 566         panic "Unable to find a medium containing a live file system"
 567     fi
 568
 569     if [ -n "${TORAM}" ]; then
 570         live_dest="ram"
 571     elif [ -n "${TODISK}" ]; then
 572         live_dest="${TODISK}"
 573     fi
 574     if [ -n "${live_dest}" ]; then
 575         [ "$quiet" != "y" ] && log_begin_msg "Copying live_media to ${live_dest}"
 576         copy_live_to "${livefs_root}" "${live_dest}"
 577         [ "$quiet" != "y" ] && log_end_msg
 578     fi
 579
 580     mount_images_in_directory "${livefs_root}" "${rootmnt}"
 581
 582     log_end_msg
 583
 584     maybe_break casper-bottom
 585     [ "$quiet" != "y" ] && log_begin_msg "Running /scripts/casper-bottom"
 586
 587     pulsate
 588     run_scripts /scripts/casper-bottom
 589     [ "$quiet" != "y" ] && log_end_msg
 590
 591     exec 1>&6 6>&-
 592     exec 2>&7 7>&-
 593     cp casper.log "${rootmnt}/var/log/"
 594 }