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