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