X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=bin%2Flive-snapshot;h=5a7b97903b3fc3ec15a3a352dbff8db2ded95dc2;hb=116f7ddd2e6ebb1377474da592b7d43604e7b166;hp=c50bcc061a41a127eaf0c0b7c9a7f8e4fffb4e88;hpb=8e528a99632ef0ae43826dd7a487c4a0c12010a6;p=live-boot-grml.git diff --git a/bin/live-snapshot b/bin/live-snapshot index c50bcc0..5a7b979 100755 --- a/bin/live-snapshot +++ b/bin/live-snapshot @@ -2,16 +2,17 @@ # live-snapshot - utility to manage Debian Live systems snapshots # -# This program mount a device (fallback to /tmpfs under /mnt/snapshot -# and save the /live/cow (or a different dir) filesystem in it for reusing -# in another live-initramfs session. Look at manpage for more info. +# This program mounts a device (fallback to /tmpfs under $MOUNTP +# and saves the /live/cow (or a different directory) filesystem in it +# for reuse in another live-initramfs session. +# Look at the manpage for more informations. # -# 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 +# 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 -# the Free Software Foundation; either version 2 of the License, or +# the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, @@ -20,29 +21,49 @@ # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +# along with this program. If not, see . # # On Debian systems, the complete text of the GNU General Public License -# can be found in /usr/share/common-licenses/GPL-2 file. +# can be found in /usr/share/common-licenses/GPL-3 file. -set -eu +# declare here two vars from /etc/live.conf because of "set -u" +ROOTSNAP="" +HOMESNAP="" + +if [ -n "${LIVE_SNAPSHOT_CHECK_UNBOUND}" ] +then + set -eu +else + set -e +fi . /usr/share/initramfs-tools/scripts/live-helpers -. /etc/live.conf + +LIVE_CONF="/etc/live.conf" +. "${LIVE_CONF}" export USERNAME USERFULLNAME HOSTNAME -PROGRAM="$(basename $0)" -VERSION=0.0.2 +EXECUTABLE="${0}" +PROGRAM=$(basename "${EXECUTABLE}") -MOUNTP="/mnt/live-snapshot" -SNAP_COW="/live/cow" -SNAP_DEV="" +# 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)" DEST="${MOUNTP}/live-sn.cpio.gz" -SNAP_TYPE="cpio" -DESKTOP_LINK="/home/${USERNAME}/Desktop/live-snapshot" +DEF_SNAP_COW="/live/cow" +TMP_FILELIST="${PROGRAM}.list" + +# Command line defaults and declarations +SNAP_COW="${DEF_SNAP_COW}" +SNAP_DEV="" +SNAP_OUTPUT="" SNAP_RESYNC_STRING="" +SNAP_TYPE="cpio" +SNAP_LIST="/etc/live-snapshot.list" +EXCLUDE_LIST="/etc/live-snapshot.exclude_list" Error () { @@ -61,6 +82,7 @@ Header () echo echo "usage: ${PROGRAM} [-c|--cow DIRECTORY] [-d|--device DEVICE] [-o|--output FILE] [-t|--type TYPE]" echo " ${PROGRAM} [-r|--resync-string STRING]" + echo " ${PROGRAM} [-f|--refresh]" echo " ${PROGRAM} [-h|--help]" echo " ${PROGRAM} [-u|--usage]" echo " ${PROGRAM} [-v|--version]" @@ -76,6 +98,7 @@ Help () 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 " -f, --refresh: try to sync a running snapshot." 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." @@ -92,13 +115,13 @@ Usage () 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" @@ -122,16 +145,24 @@ Version () exit 0 } -Is_same_mount () +Try_refresh () { - dir1="$(Base_path ${1})" - dir2="$(Base_path ${2})" + FOUND="" + if [ -n "${ROOTSNAP}" ]; then + "${EXECUTABLE}" --resync-string="${ROOTSNAP}" + FOUND="Yes" + fi + + if [ -n "${HOMESNAP}" ]; then + "${EXECUTABLE}" --resync-string="${HOMESNAP}" + FOUND="Yes" + fi - if [ "${dir1}" = "${dir2}" ] + if [ -z "${FOUND}" ] then - return 0 - else - return 1 + echo "No autoconfigured snapshots found at boot;" > /dev/null 1>&2 + echo "(no resync string in ${LIVE_CONF})." > /dev/null 1>&2 + exit 1 fi } @@ -139,7 +170,7 @@ Parse_args () { # Parse command line 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})" + ARGUMENTS="$(getopt --longoptions cow:,device:,output,resync-string:,refresh,type:,help,usage,version --name=${PROGRAM} --options c:d:o:t:r:fhuv --shell sh -- ${ARGS})" eval set -- "${ARGUMENTS}" @@ -171,6 +202,11 @@ Parse_args () break ;; + -f|--refresh) + Try_refresh + exit 0 + ;; + -h|--help) Help ;; @@ -194,7 +230,6 @@ Parse_args () esac done - } Defaults () @@ -204,7 +239,7 @@ Defaults () 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 ':') + DEST="${MOUNTP}/$(echo ${SNAP_RESYNC_STRING} | cut -f3 -d ':')" case "${DEST}" in *.cpio.gz) @@ -226,8 +261,8 @@ Defaults () Error "unrecognized resync string" ;; esac - - else + elif [ -z "${SNAP_OUTPUT}" ] + then # Set target file based on image case "${SNAP_TYPE}" in cpio) @@ -242,15 +277,17 @@ Defaults () DEST="${MOUNTP}/live-sn.ext2" ;; esac + else + DEST="${SNAP_OUTPUT}" fi - } Validate_input () { - case "${SNAP_TYPE}" in + case "${SNAP_TYPE}" in cpio|squashfs|jffs2|ext2|ext3) ;; + *) Error "invalid filesystem type \"${SNAP_TYPE}\"" ;; @@ -269,13 +306,12 @@ Validate_input () Mount_device () { - mkdir -p "${MOUNTP}" - case "${SNAP_DEV}" in "") # create a temp mount -t tmpfs -o rw tmpfs "${MOUNTP}" ;; + *) if [ -b "${SNAP_DEV}" ] then @@ -285,20 +321,104 @@ Mount_device () esac } +Entry_is_modified () +{ + # Returns true if file exists and it is also present in "cow" directory + # This means it is modified in respect to read-only media, so it deserve + # to be saved + + entry="${1}" + + if [ -e "${entry}" ] || [ -L "${entry}" ] + then + if [ -e "${DEF_SNAP_COW}/${entry}" ] || [ -L "${DEF_SNAP_COW}/${entry}" ] + then + return 0 + fi + fi + return 1 +} + +Do_filelist () +{ + # BUGS: supports only cpio.gz types, and do not handle deleted files yet + + TMP_FILELIST=$1 + if [ -f "${SNAP_LIST}" ] + then + # Generate include list + for entry in $(cat "${SNAP_LIST}" | grep -v '^#.*$' | grep -v '^ *$') + do + if [ -d "${entry}" ] + then + cd / + find "${entry}" | while read line + do + if Entry_is_modified "${line}" + then + printf "%s\000" "${line}" >> "${TMP_FILELIST}" + fi + done + cd "${OLDPWD}" + elif Entry_is_modified "${entry}" + then + # if file exists and it is modified + printf "%s\000" "${entry}" >> "${TMP_FILELIST}" + fi + done + + if [ "${SNAP_COW}" = "${DEF_SNAP_COW}" ] + then + # Relative to rootfs + echo "/" + else + # Mostly "/home" + echo "${SNAP_COW}" + fi + else + cd "${SNAP_COW}" + find . -path '*.wh.*' -prune -o -print0 >> "${TMP_FILELIST}" + cd "${OLDPWD}" + echo "${SNAP_COW}" + fi +} + Do_snapshot () { + TMP_FILELIST=$(mktemp -p "${SAFE_TMPDIR}" "${TMP_FILELIST}.XXXXXX") + case "${SNAP_TYPE}" in squashfs) - echo "./tmp/exclude_list" > /tmp/exclude_list - ( cd "${SNAP_COW}" && find . -name '*.wh.*' >> /tmp/exclude_list ) - mksquashfs "${SNAP_COW}" "${DEST}" -ef /tmp/exclude_list - rm /tmp/exclude_list + echo ".${TMP_FILELIST}" > "${TMP_FILELIST}" + # Removing whiteheads of unionfs + cd "${SNAP_COW}" + find . -name '*.wh.*' >> "${TMP_FILELIST}" + + if [ -e "${EXCLUDE_LIST}" ] + then + # Add explicitly excluded files + cat "${EXCLUDE_LIST}" | grep -v '^#.*$' | grep -v '^ *$' >> "${TMP_FILELIST}" + fi + + cd "${OLDPWD}" + mksquashfs "${SNAP_COW}" "${DEST}" -ef "${TMP_FILELIST}" ;; cpio) - ( cd "${SNAP_COW}" && find . -path '*.wh.*' -prune -o -print0 | cpio --quiet -o0 -H newc | gzip -9c > "${DEST}" ) || exit 1 + WORKING_DIR=$(Do_filelist "${TMP_FILELIST}") + cd "${WORKING_DIR}" + if [ -e "${EXCLUDE_LIST}" ] + then + # Convert \0 to \n and tag existing (rare but possible) \n in filenames, + # this to let grep -F -v do a proper work in filtering out + cat "${TMP_FILELIST}" | tr '\n' '\1' | tr '\0' '\n' | grep -F -v -f "${EXCLUDE_LIST}" | tr '\n' '\0' | tr '\1' '\n' | cpio --quiet -o0 -H newc | gzip -9c > "${DEST}" || exit 1 + else + cat "${TMP_FILELIST}" | cpio --quiet -o0 -H newc | gzip -9c > "${DEST}" || exit 1 + fi + cd "${OLDPWD}" ;; + # ext2|ext3 and jffs2 does not support easely an exclude list, files should be copied in another directory in order to filter content 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... @@ -309,11 +429,16 @@ Do_snapshot () mkfs.jffs2 --root="${SNAP_COW}" --output="${DEST}" ;; esac + + if [ -f "${TMP_FILELIST}" ] + then + rm -f "${TMP_FILELIST}" + fi } Clean () { - if echo "${DEST}" | grep -q "${MOUNTP}" + if [ -z "${SNAP_RESYNC_STRING}" ] && echo "${DEST}" | grep -q "${MOUNTP}" then echo "${DEST} is present on ${MOUNTP}, therefore no automatic unmounting the latter." > /dev/null 1>&2 else @@ -322,14 +447,42 @@ Clean () fi } +Warn_user () +{ + if [ -z "${SNAP_RESYNC_STRING}" ] + then + case ${SNAP_TYPE} in + cpio|ext2|ext3) + echo "Please move ${DEST} (if is not already in it)" > /dev/null 1>&2 + echo "in a supported writable partition (e.g ext3, vfat)." > /dev/null 1>&2 + ;; + + squashfs) + echo "To use ${DEST} you need to rebuild your media or add it" > /dev/null 1>&2 + echo "to your multisession disc under the \"/live\" directory." > /dev/null 1>&2 + ;; + + jffs2) + echo "Please cat or flashcp ${DEST} to your partition in order to start using it." > /dev/null 1>&2 + ;; + esac + + if grep -qv persistent /proc/cmdline + then + echo "Remember to boot this live system with \"persistent\" specified at boot prompt." > /dev/null 1>&2 + fi + fi +} + Main () { Parse_args "${@}" Defaults Validate_input - trap 'Clean' EXIT + trap 'Clean' EXIT Mount_device Do_snapshot + Warn_user } Main "${@:-}"