X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=bin%2Flive-snapshot;h=dc1fa6d70ae8debe1e81147108ecb4997aeccc4b;hb=f3f5d28186570ff2425e690318e1335b56eea328;hp=3f9c11c04dda25dc20a6193c8a33666b0f3a16a3;hpb=7289bfd7372774a6ff880d0eee085733bd0802a7;p=live-boot-grml.git diff --git a/bin/live-snapshot b/bin/live-snapshot index 3f9c11c..dc1fa6d 100755 --- a/bin/live-snapshot +++ b/bin/live-snapshot @@ -1,12 +1,13 @@ -#! /bin/bash +#!/bin/sh # live-snapshot - utility to manage Debian Live systems snapshots # -# This program mount a device (fallback to /tmpfs under /mnt/snapshot -# and save the /cow (or a different dir) filesystem in it for reusing +# This program mounts a device (fallback to /tmpfs under $MOUNTP +# and saves the /live/cow (or a different dir) filesystem in it for reuse # in another live-initramfs session. Look at manpage for more info. # -# Copyright (C) 2006 Marco Amadori +# Copyright (C) 2006-2008 Marco Amadori +# Copyright (C) 2008 Chris Lamb # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -23,87 +24,84 @@ # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # # On Debian systems, the complete text of the GNU General Public License -# can be found in /usr/share/common-licenses/GPL file. +# can be found in /usr/share/common-licenses/GPL-2 file. -PROGRAM="`basename $0`" -VERSION=0.0.1 +set -eu +. /usr/share/initramfs-tools/scripts/live-helpers +. /etc/live.conf -# Source live conf -if [ -e /etc/live.conf ]; then - . /etc/live.conf -else - USERNAME=$(cat /etc/passwd | grep "999" | cut -f1 -d ':') - HOSTNAME=$(hostname) - BUILD_SYSTEM="Debian" -fi +export USERNAME USERFULLNAME HOSTNAME -export USERNAME USERFULLNAME HOSTNAME BUILD_SYSTEM +PROGRAM="$(basename $0)" -# Source helper functions -helpers="/usr/share/initramfs-tools/scripts/live-helpers" -if [ -e "${helpers}" ]; then - . "${helpers}" -else - echo "Error: I cannot found helper functions \"${helpers}\"." - exit 1 -fi +# Needs to be available at run and reboot time +SAFE_TMPDIR="/live" + +# Permits multiple runs +MOUNTP="$(mktemp -d -p ${SAFE_TMPDIR} live-snapshot-mnt.XXXXXX)" +SNAP_COW="/live/cow" +SNAP_DEV="" +DEST="${MOUNTP}/live-sn.cpio.gz" +SNAP_TYPE="cpio" +DESKTOP_LINK="/home/${USERNAME}/Desktop/live-snapshot" +SNAP_RESYNC_STRING="" -# Define LSB log_* functions. -# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. -. /lib/lsb/init-functions +Error () +{ + echo "${PROGRAM}: error:" ${@} + exit 1 +} -MOUNTP="" -COW="" -DEV="" -DEST="" -TYPE="" -DESKTOP_LINK="" +panic () +{ + Error ${@} +} Header () { - echo "${PROGRAM} - utility to do Debian Live snapshots" + echo "${PROGRAM} - utility to perform snapshots of Debian Live systems" echo - echo "Usage: ${PROGRAM} [-c|--cow DIRECTORY] [-d|--device DEVICE] [-o|--output FILE] [-t|--type TYPE]" - echo "Usage: ${PROGRAM} [-r|--resync-string STRING]" - echo "Usage: ${PROGRAM} [-h|--help]" - echo "Usage: ${PROGRAM} [-u|--usage]" - echo "Usage: ${PROGRAM} [-v|--version]" + echo "usage: ${PROGRAM} [-c|--cow DIRECTORY] [-d|--device DEVICE] [-o|--output FILE] [-t|--type TYPE]" + echo " ${PROGRAM} [-r|--resync-string STRING]" + echo " ${PROGRAM} [-h|--help]" + echo " ${PROGRAM} [-u|--usage]" + echo " ${PROGRAM} [-v|--version]" } -Usage () +Help () { - MESSAGE=${1} Header + echo - echo "Try \"${PROGRAM} --help\" for more information." - if [ ! -z "${MESSAGE}" ]; then - echo -e "${MESSAGE}" - exit 1 - else - exit 0 - fi + echo "Options:" + echo " -c, --cow: copy on write directory (default: ${SNAP_COW})." + echo " -d, --device: output snapshot device (default: ${SNAP_DEV:-auto})." + echo " -o, --output: output image file (default: ${DEST})." + echo " -r, --resync-string: internally used to resync previous made snapshots." + echo " -t, --type: snapshot filesystem type. Options: \"squashfs\", \"ext2\", \"ext3\", \"jffs2\" or \"cpio\".gz archive (default: ${SNAP_TYPE})" + echo + echo "Look at live-snapshot(1) man page for more information." + + exit 0 } -Help () +Usage () { Header + echo - echo "Options:" - echo " -c, --cow: specifies the copy on write directory (default: /cow)." - echo " -d, --device: specifies the output snapshot device (default: none)." - echo " -o, --output: specifies the output image file (default: $type dependent)." - echo " -r, --resync-string: internally used to resync previous made snapshots." - echo " -t, --type: specifies the snapshot type between \"squashfs\", \"ext2\", \"ext3\" or \"cpio\".gz archive (default: cpio)" - echo -e "\nLook at live-snapshot(1) man page for more information." + echo "Try \"${PROGRAM} --help\" for more information." + exit 0 } Version () { - echo "${PROGRAM}, version ${VERSION}" + echo "${PROGRAM}" echo echo "Copyright (C) 2006 Marco Amadori " + echo "Copyright (C) 2008 Chris Lamb " echo echo "This program is free software; you can redistribute it and/or modify" echo "it under the terms of the GNU General Public License as published by" @@ -120,41 +118,20 @@ Version () echo "Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA" echo echo "On Debian systems, the complete text of the GNU General Public License" - echo "can be found in /usr/share/common-licenses/GPL file." + echo "can be found in /usr/share/common-licenses/GPL-2 file." echo echo "Homepage: " - exit 0 -} -Do_snapshot () -{ - case "${TYPE}" in - squashfs) - echo "./tmp/exclude_list" > /tmp/exclude_list - ( cd "${COW}" && find . -name '*.wh.*' >> /tmp/exclude_list ) - mksquashfs "${COW}" "${DEST}" -ef /tmp/exclude_list || exit 1 - rm /tmp/exclude_list - ;; - cpio) - ( cd "${COW}" && find . -path '*.wh.*' -prune -o -print0 | cpio --quiet -o0 -H newc | gzip -9c > "${DEST}" ) || exit 1 - ;; - ext2|ext3) - DU_DIM="`du -ks ${COW} | cut -f1`" - REAL_DIM="`expr ${DU_DIM} + ${DU_DIM} / 20`" # Just 5% more to be sure, need something more sophistcated here... - genext2fs --size-in-blocks=${REAL_DIM} --reserved-blocks=0 --root="${COW}" "${DEST}" || exit 1 - ;; - *) - echo "Internal error." - exit 1 - ;; - esac + exit 0 } Is_same_mount () { - dir1="`Base_path $1`" - dir2="`Base_path $2`" - if [ "${dir1}" = "${dir2}" ]; then + dir1="$(Base_path ${1})" + dir2="$(Base_path ${2})" + + if [ "${dir1}" = "${dir2}" ] + then return 0 else return 1 @@ -164,136 +141,200 @@ Is_same_mount () Parse_args () { # Parse command line - ARGS="$1" - ARGUMENTS="`getopt --longoptions cow:,device:,output,resync-string:,type:,help,usage,version --name=${PROGRAM} --options c:d:o:t:r:,h,u,v --shell sh -- ${ARGS}`" - - if [ "$?" != "0" ]; then - echo "Terminating." >&2 - exit 1 - fi + ARGS="${*}" + ARGUMENTS="$(getopt --longoptions cow:,device:,output,resync-string:,type:,help,usage,version --name=${PROGRAM} --options c:d:o:t:r:,h,u,v --shell sh -- ${ARGS})" eval set -- "${ARGUMENTS}" - while true; do - case "$1" in + while true + do + case "${1}" in -c|--cow) - SNAP_COW="$2"; shift 2 ;; + SNAP_COW="${2}" + shift 2 + ;; + -d|--device) - SNAP_DEV="$2"; shift 2 ;; + SNAP_DEV="${2}" + shift 2 + ;; + -o|--output) - SNAP_OUTPUT="$2"; shift 2 ;; + SNAP_OUTPUT="${2}" + shift 2 + ;; + -t|--type) - SNAP_TYPE="$2"; shift 2 ;; + SNAP_TYPE="${2}" + shift 2 + ;; + -r|--resync-string) - SNAP_RSTRING="$2"; break ;; + SNAP_RESYNC_STRING="${2}" + break + ;; + -h|--help) - Help; shift ;; + Help + ;; + -u|--usage) - Usage ; shift ;; + Usage + ;; + -v|--version) - Version; shift ;; + Version + ;; + --) - shift; break ;; + shift + break + ;; + *) - echo "Internal error."; exit 1 ;; + Error "internal error." + ;; + esac done } -Mount_device () -{ - dev="$1" - - if [ ! -d "${MOUNTP}" ]; then - mkdir -p "${MOUNTP}" - fi - - if [ -z "${dev}" ]; then - # create a temp - mount -t tmpfs -o rw tmpfs "${MOUNTP}" - if [ ! -L /home/$USERNAME/Desktop/live-snapshot ]; then - ln -s "${MOUNTP}" /home/$USERNAME/Desktop/live-snapshot - fi - else - if [ -b "${dev}" ] ; then - try_mount "${dev}" "${MOUNTP}" rw - fi - fi -} - Defaults () { - MOUNTP="/mnt/live-snapshot" - COW="/cow" - DEV="" - DEST="${MOUNTP}/live-sn.cpio.gz" - TYPE="cpio" - DESKTOP_LINK=/home/$USERNAME/Desktop/live-snapshot - - if [ -n "${SNAP_RSTRING}" ]; then - COW=$(echo "${SNAP_RSTRING}" | cut -f1 -d ':') - DEV=$(echo "${SNAP_RSTRING}" | cut -f2 -d ':') - DEST=$(echo "${SNAP_RSTRING}" | cut -f3 -d ':') + # Parse resync string + if [ -n "${SNAP_RESYNC_STRING}" ] + then + SNAP_COW=$(echo "${SNAP_RESYNC_STRING}" | cut -f1 -d ':') + SNAP_DEV=$(echo "${SNAP_RESYNC_STRING}" | cut -f2 -d ':') + DEST=$(echo "${SNAP_RESYNC_STRING}" | cut -f3 -d ':') case "${DEST}" in *.cpio.gz) - TYPE="cpio" ;; + SNAP_TYPE="cpio" + ;; + *.squashfs) - TYPE="squashfs" ;; - "") - TYPE="ext2" ;; - *.ext2|*.ext3) - TYPE="ext2" ;; + SNAP_TYPE="squashfs" + ;; + + *.jffs2) + SNAP_TYPE="jffs2" + ;; + + ""|*.ext2|*.ext3) + SNAP_TYPE="ext2" + ;; *) - Usage "Unregognized String" ;; + Error "unrecognized resync string" + ;; esac else - DEF_COW="/cow" - # Bad options handling - if [ -z "${SNAP_COW}" ]; then - COW="${DEF_COW}" - else - COW="${SNAP_COW}" - fi - + # Set target file based on image case "${SNAP_TYPE}" in - "cpio"|"squashfs"|"ext2"|"ext3") - TYPE="${SNAP_TYPE}" + cpio) + DEST="${MOUNTP}/live-sn.cpio.gz" ;; - "") - TYPE="cpio" ;; - *) - Usage "Error: unrecognized snapshot type" + + squashfs|jffs2|ext2) + DEST="${MOUNTP}/live-sn.${SNAP_TYPE}" + ;; + + ext3) + DEST="${MOUNTP}/live-sn.ext2" ;; esac - #if [ -d - #if Is_same_mount + fi +} + +Validate_input () +{ + case "${SNAP_TYPE}" in + cpio|squashfs|jffs2|ext2|ext3) + ;; + + *) + Error "invalid filesystem type \"${SNAP_TYPE}\"" + ;; + esac + + if [ ! -d "${SNAP_COW}" ] + then + Error "${SNAP_COW} is not a directory" fi - # check vars - if [ ! -d "${COW}" ]; then - Usage "Error: ${COW} is not a directory" + if [ "$(id -u)" -ne 0 ] + then + Error "you are not root" fi +} - Mount_device $DEV +Mount_device () +{ + mkdir -p "${MOUNTP}" + case "${SNAP_DEV}" in + "") + # create a temp + mount -t tmpfs -o rw tmpfs "${MOUNTP}" + ;; + + *) + if [ -b "${SNAP_DEV}" ] + then + try_mount "${SNAP_DEV}" "${MOUNTP}" rw + fi + ;; + esac +} + +Do_snapshot () +{ + case "${SNAP_TYPE}" in + squashfs) + EXCLUDE_LIST="$(mktemp -p ${SAFE_TMPDIR} live-snapshot-exclude-list.XXXXXX)" + echo "./${EXCLUDE_LIST}" > "${EXCLUDE_LIST}" + cd "${SNAP_COW}" + find . -name '*.wh.*' >> "${EXCLUDE_LIST}" + cd "${OLDPWD}" + mksquashfs "${SNAP_COW}" "${DEST}" -ef "${EXCLUDE_LIST}" + rm -f "${EXCLUDE_LIST}" + ;; + + cpio) + ( cd "${SNAP_COW}" && find . -path '*.wh.*' -prune -o -print0 | cpio --quiet -o0 -H newc | gzip -9c > "${DEST}" ) || exit 1 + ;; + + ext2|ext3) + DU_DIM="$(du -ks ${SNAP_COW} | cut -f1)" + REAL_DIM="$(expr ${DU_DIM} + ${DU_DIM} / 20)" # Just 5% more to be sure, need something more sophistcated here... + genext2fs --size-in-blocks=${REAL_DIM} --reserved-percentage=0 --root="${SNAP_COW}" "${DEST}" + ;; + + jffs2) + mkfs.jffs2 --root="${SNAP_COW}" --output="${DEST}" + ;; + esac } Clean () { - if [ -n "$DEV" ]; then + if echo "${DEST}" | grep -q "${MOUNTP}" + then + echo "${DEST} is present on ${MOUNTP}, therefore no automatic unmounting the latter." > /dev/null 1>&2 + else umount "${MOUNTP}" rmdir "${MOUNTP}" - #rm fi } Main () { - Parse_args "$@" + Parse_args "${@}" Defaults + Validate_input + trap 'Clean' EXIT + Mount_device Do_snapshot - Clean } -Main "$@" +Main "${@:-}"