Merge branch 'topic/hanoi' of git://github.com/rdparker/zfs-auto-snapshot into hanoi

Makefile

@@ -1,18 +1,16 @@
-PREFIX := /usr/local
-
 all:
 
 install:
-	install -d $(DESTDIR)/etc/cron.d
+	install -d $(DESTDIR)$(PREFIX)/etc/cron.d
-	install -d $(DESTDIR)/etc/cron.daily
+	install -d $(DESTDIR)$(PREFIX)/etc/cron.daily
-	install -d $(DESTDIR)/etc/cron.hourly
+	install -d $(DESTDIR)$(PREFIX)/etc/cron.hourly
-	install -d $(DESTDIR)/etc/cron.weekly
+	install -d $(DESTDIR)$(PREFIX)/etc/cron.weekly
-	install -d $(DESTDIR)/etc/cron.monthly
+	install -d $(DESTDIR)$(PREFIX)/etc/cron.monthly
-	install -m 0644 etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)$(PREFIX)/etc/cron.d/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.hourly   $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.hourly   $(DESTDIR)$(PREFIX)/etc/cron.hourly/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.daily    $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.daily    $(DESTDIR)$(PREFIX)/etc/cron.daily/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.weekly   $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.weekly   $(DESTDIR)$(PREFIX)/etc/cron.weekly/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.monthly  $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.monthly  $(DESTDIR)$(PREFIX)/etc/cron.monthly/zfs-auto-snapshot
 	install -d $(DESTDIR)$(PREFIX)/share/man/man8
 	install src/zfs-auto-snapshot.8 $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
 	install -d $(DESTDIR)$(PREFIX)/sbin

README

@@ -10,12 +10,3 @@ snapshots if it is installed.
 
 This program is a posixly correct bourne shell script.  It depends only on
 the zfs utilities and cron, and can run in the dash shell.
-
-
-Installation:
--------------
-
-wget https://github.com/zfsonlinux/zfs-auto-snapshot/archive/master.zip
-unzip master.zip
-cd zfs-auto-snapshot-master
-make install

debian/changelog

@@ -1,100 +0,0 @@
-zfs-auto-snapshot (1.2.0-1) unstable; urgency=low
-
-  [ Roland Stühmer ]
-  * Fix SNAPNAME to contain the DATE if label is empty
-
-  [ Borut Mrak ]
-  * Remove PREFIX from cron scripts - they should always end up in /etc.
-  * Leave PREFIX for man page and program, and set it to /usr/local by default.
-
-  [ Maciej Małecki ]
-  * Add `--{pre,post}-snapshot` for pre and post creation hook
-  * Abort if pre snapshot hook returns non-zero
-  * Document `--{pre,post}-snapshot
-
-  [ Mike Baynton ]
-  * Make --{pre,post}-snapshot optional, add --destroy-only, revise docs
-
-  [ virtualguy ]
-  * Update README
-
-  [ Darik Horn ]
-  * Install the cron.d part without the execute bit.
-  * Update debian/rules for Makefile changes.
-
- -- Darik Horn <dajhorn@vanadac.com>  Mon, 13 Oct 2014 23:17:30 -0500
-
-zfs-auto-snapshot (1.1.0-0ubuntu1) unstable; urgency=low
-
-  [ Markus Heberling ]
-  * Use only name property for zfs list
-
-  [ Darik Horn ]
-  * Add a switch for the fast zfs list invocation.
-
-  [ Mike Swanson ]
-  * Add a manpage
-  * Update Makefile for the manual page
-
-  [ HawkOwl ]
-  * Set the snapshots to use UTC time, which makes the date/time display correctly in Windows 7 Previous Versions.
-
- -- Darik Horn <dajhorn@vanadac.com>  Mon, 31 Mar 2014 01:48:58 -0500
-
-zfs-auto-snapshot (1.0.8-0ubuntu2) unstable; urgency=low
-
-  * Update the debian/control file.
-
- -- Darik Horn <dajhorn@vanadac.com>  Sun, 31 Mar 2013 23:10:55 -0500
-
-zfs-auto-snapshot (1.0.8-0ubuntu1) unstable; urgency=low
-
-  * Update the README file to be more descriptive.
-  * Fix pool exclusions.
-
- -- Darik Horn <dajhorn@vanadac.com>  Sat, 21 Jan 2012 16:37:28 -0600
-
-zfs-auto-snapshot (1.0.7-0ubuntu1) unstable; urgency=low
-
-  [ Darik Horn ]
-  * Change objects to datasets in help and comments.
-  * Set keep=8 in the weekly cron job.
-
-  [ Ulrich Petri ]
-  * Fixed --prefix and --sep regexes
-
- -- Darik Horn <dajhorn@vanadac.com>  Wed, 28 Dec 2011 13:30:02 -0600
-
-zfs-auto-snapshot (1.0.6-0ubuntu1) unstable; urgency=low
-
-  * Remove redundant lines in the cron.d file.
-  * Fix the hourly-daily transposition in the Makefile.
-
- -- Darik Horn <dajhorn@vanadac.com>  Mon, 28 Nov 2011 00:10:05 -0600
-
-zfs-auto-snapshot (1.0.5-0ubuntu1) unstable; urgency=low
-
-  * Split the cron file for anacron compatibilty.
-
- -- Darik Horn <dajhorn@vanadac.com>  Fri, 25 Nov 2011 14:28:07 -0600
-
-zfs-auto-snapshot (1.0.4-0ubuntu1) unstable; urgency=low
-
-  * Invert the --skip-scrub test.
-  * Fold the main loops into a do_snapshots function.
-  * Consistently quote literal strings.
-  * Implement --prefix parameter checking.
-  * Rebase exit codes to above 127.
-  * Implement the --event option for :auto-snap-desc.
-
- -- Darik Horn <dajhorn@vanadac.com>  Wed, 23 Nov 2011 10:49:14 -0600
-
-zfs-auto-snapshot (1.0.3-0ubuntu1) unstable; urgency=low
-
-  * Add -q to the getopt list of short options.
-  * Add an explicit `exit 0` to the end of the script.
-  * Add gbp.conf file for git-buildpackage.
-  * Expand the options variable in the cron part file.
-  * Initial debian packaging.
-
- -- Darik Horn <dajhorn@vanadac.com>  Mon, 21 Nov 2011 21:52:11 -0600

debian/compat

@@ -1 +0,0 @@
-7

debian/control

@@ -1,16 +0,0 @@
-Source: zfs-auto-snapshot
-Section: admin
-Priority: extra
-Maintainer: Darik Horn <dajhorn@vanadac.com>
-Build-Depends: debhelper (>= 8)
-Standards-Version: 3.9.4
-Homepage: http://www.zfsonlinux.org/
-Vcs-Git: git://github.com/zfsonlinux/zfs-auto-snapshot.git
-Vcs-Browser: https://github.com/zfsonlinux/zfs-auto-snapshot/
-
-Package: zfs-auto-snapshot
-Architecture: all
-Depends: ${misc:Depends}, cron, zfsutils
-Description: ZFS Automatic Snapshot Service
- Automatically create and destroy ZFS snapshots on an hourly, daily, weekly
- and monthly schedule.

debian/copyright

@@ -1 +0,0 @@
-Copyright 2011 Darik Horn <dajhorn@vanadac.com>

debian/gbp.conf

@@ -1,3 +0,0 @@
-[DEFAULT]
-upstream-branch = master
-debian-branch = debian

debian/rules

@@ -1,7 +0,0 @@
-#!/usr/bin/make -f
-
-%:
-	dh $@
-
-override_dh_auto_install:
-	dh_auto_install -- PREFIX=/usr

debian/watch

@@ -1,2 +0,0 @@
-version=3
-http://githubredir.debian.net/github/dajhorn/zfs-auto-snapshot/([\d\.].*).tar.gz

src/zfs-auto-snapshot.8

@@ -64,27 +64,6 @@ Snapshot named filesystem and all descendants.
 \fB\-v\fR, \fB\-\-verbose\fR
 Print info messages.
 .TP
-\fB\-\-pre-snapshot\fR=\fICOMMAND\fR
-Command to run before each dataset is snapshotted. 
-It is passed the dataset and snapshot name. If it
-returns non-zero, snapshotting this dataset is 
-aborted.
-.TP
-\fB\-\-post-snapshot\fR=\fICOMMAND\fR
-Command to run after each dataset is snapshotted. 
-It is passed the dataset and snapshot name.
-.TP
-\fB\-\-destroy-only\fR
-Do not create new snapshots, but do destroy older 
-snapshots. Has no effect unless used with \fB\-k\fR.
-.IP
-A non-obvious use may be constructon of cron jobs or
-scripts that run pre-snapshot command(s), then run 
-zfs-auto-snapshot (without \fB\-k\fR) to quickly
-snapshot all datasets, then run post-snapshot
-command(s) and clean up with zfs-auto-snapshot
-\fB\-\-destroy-only\fR.
-.TP
 name
 Filesystem and volume names, or '//' for all ZFS datasets.
 .SH SEE ALSO

src/zfs-auto-snapshot.sh

@@ -39,9 +39,6 @@ opt_setauto=''
 opt_syslog=''
 opt_skip_scrub=''
 opt_verbose=''
-opt_pre_snapshot=''
-opt_post_snapshot=''
-opt_do_snapshots=1
 
 # Global summary statistics.
 DESTRUCTION_COUNT='0'
@@ -62,6 +59,10 @@ print_usage ()
   -n, --dry-run      Print actions without actually doing anything.
   -s, --skip-scrub   Do not snapshot filesystems in scrubbing pools.
   -h, --help         Print this usage message.
+  -H, --hanoi=INT    Use the hanoi rotation scheme.
+		     INT how frequently the hanoi rotation is being run.
+		     It is a number followed by one of w, d, h, m, s for
+		     weeks, days, hours, minutes or seconds.
   -k, --keep=NUM     Keep NUM recent snapshots and destroy older snapshots.
   -l, --label=LAB    LAB is usually 'hourly', 'daily', or 'monthly'.
   -p, --prefix=PRE   PRE is 'zfs-auto-snap' by default.
@@ -72,7 +73,6 @@ print_usage ()
   -g, --syslog       Write messages into the system log.
   -r, --recursive    Snapshot named filesystem and all descendants.
   -v, --verbose      Print info messages.
-      --destroy-only Only destroy older snapshots, do not create new ones.
       name           Filesystem and volume names, or '//' for all ZFS datasets.
 " 
 }
@@ -144,6 +144,123 @@ do_run () # [argv]
 }
 
 
+do_rotate () # flags, oldglob, target
+{
+	local FLAGS="$1"
+	local GLOB="$2"
+	local TARGET="$3"
+	local KEEP=''
+
+	# global DESTRUCTION_COUNT
+	# global WARNING_COUNT
+	# global SNAPSHOTS_OLD
+
+	# Retain at most $opt_keep number of old snapshots of this filesystem,
+	# including the one that was just recently created.
+	KEEP="$opt_keep"
+
+	# ASSERT: The old snapshot list is sorted by increasing age.
+	for jj in $SNAPSHOTS_OLD
+	do
+		# Check whether this is an old snapshot of the filesystem.
+		if [ -z "${jj#$TARGET@$GLOB}" ]
+		then
+			KEEP=$(( $KEEP - 1 ))
+			if [ "$KEEP" -le '0' ]
+			then
+				if do_run "zfs destroy $FLAGS '$jj'" 
+				then
+					DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
+				else
+					WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
+				fi
+			fi
+		fi
+	done
+}
+
+
+compute_hanoi_level() # date
+{
+	local DATE="$1"
+	local EPOCH_TIME=''
+	local HANOI_NUM=''
+	local HANOI_LEVEL='1'
+
+	# The h* is because on Solaris %H%M will have generated 12h34
+	EPOCH_TIME=$(date +%s --date="$(echo $DATE | sed 's/-\(..\)h*\(..\)$/ \1:\2/')")
+	HANOI_NUM=$(($EPOCH_TIME / $opt_hanoi));
+	while test "$HANOI_NUM" -ne "0"
+	do
+		case "${HANOI_NUM}" in
+			(*[13579])
+				break
+				;;
+		esac
+		HANOI_LEVEL=$(($HANOI_LEVEL + 1))
+		HANOI_NUM=$(($HANOI_NUM / 2))
+	done
+	echo $HANOI_LEVEL
+}
+
+
+do_hanoi () # flags, oldglob, target
+{
+	local FLAGS="$1"
+	local GLOB="$2"
+	local TARGET="$3"
+	local KEEP=''
+	local HANOI_LEVEL='0'
+	local SNAP_DATE=''
+	local SNAP_LEVEL=''
+	local POSSIBLY_DESTROY=''
+
+	# global DESTRUCTION_COUNT
+	# global WARNING_COUNT
+	# global SNAPSHOTS_OLD
+
+	HANOI_LEVEL=$(compute_hanoi_level "$DATE")
+
+	# Retain at most $opt_keep number of old snapshots of this filesystem,
+	# including the one that was just recently created.
+	KEEP="$opt_keep"
+
+	# ASSERT: The old snapshot list is sorted by increasing age.
+	for jj in $SNAPSHOTS_OLD
+	do
+		# Check whether this is an old snapshot of the filesystem.
+		if [ -z "${jj#$TARGET@$GLOB}" ]
+		then
+			# If younger snapshot was stored for possible
+			# deletion, delete it.
+			if [ -n "$POSSIBLY_DESTROY" ]
+			then
+				if do_run "zfs destroy $FLAGS '$POSSIBLY_DESTROY'"
+				then
+					DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
+				else
+					WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
+				fi
+				POSSIBLY_DESTROY=''
+			fi
+
+			SNAP_DATE=$(echo $jj | sed 's/.*-\(....-..-..-..h*..\)$/\1/')
+			SNAP_LEVEL=$(compute_hanoi_level "$SNAP_DATE")
+			if test "$HANOI_LEVEL" -eq "$SNAP_LEVEL"
+			then
+				# By default the hanoi rotation scheme acts as
+				# though there are an infinite number of
+				# disks.  So instead of immediately destroying
+				# this snapshot, remember it as possibly
+				# needing to be destroyed and only do so if an
+				# older snapshot is found for this set.
+				POSSIBLY_DESTROY="$jj"
+			fi
+		fi
+	done
+}
+
+
 do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 {
 	local PROPS="$1"
@@ -151,55 +268,27 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 	local NAME="$3"
 	local GLOB="$4"
 	local TARGETS="$5"
-	local KEEP=''
-	local RUNSNAP=1
 
-	# global DESTRUCTION_COUNT
 	# global SNAPSHOT_COUNT
 	# global WARNING_COUNT
-	# global SNAPSHOTS_OLD
 
 	for ii in $TARGETS
 	do
-		if [ -n "$opt_do_snapshots" ]
+		if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" 
 		then
-			if [ "$opt_pre_snapshot" != "" ]
+			SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 ))
-			then
+		else
-				do_run "$opt_pre_snapshot $ii $NAME" || RUNSNAP=0
+			WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
-			fi
+			continue
-			if [ $RUNSNAP -eq 1 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'"
-			then
-				[ "$opt_post_snapshot" != "" ] && do_run "$opt_post_snapshot $ii $NAME"
-				SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 ))
-			else
-				WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
-				continue
-			fi 
 		fi 
 
-		# Retain at most $opt_keep number of old snapshots of this filesystem,
+		if test -z "$opt_hanoi"
-		# including the one that was just recently created.
+		then
-		test -z "$opt_keep" && continue
+			test -z "$opt_keep" && continue
-		KEEP="$opt_keep"
+			do_rotate "$FLAGS" "$GLOB" "$ii"
-
+		else
-		# ASSERT: The old snapshot list is sorted by increasing age.
+			do_hanoi  "$FLAGS" "$GLOB" "$ii"
-		for jj in $SNAPSHOTS_OLD
+		fi
-		do
-			# Check whether this is an old snapshot of the filesystem.
-			if [ -z "${jj#$ii@$GLOB}" ]
-			then
-				KEEP=$(( $KEEP - 1 ))
-				if [ "$KEEP" -le '0' ]
-				then
-					if do_run "zfs destroy $FLAGS '$jj'" 
-					then
-						DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
-					else
-						WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
-					fi
-				fi
-			fi
-		done
 	done
 }
 
@@ -209,10 +298,9 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 
 GETOPT=$(getopt \
   --longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \
-  --longoptions=event:,keep:,label:,prefix:,sep: \
+  --longoptions=event:,hanoi:,keep:,label:,prefix:,sep: \
   --longoptions=debug,help,quiet,syslog,verbose \
-  --longoptions=pre-snapshot:,post-snapshot:,destroy-only \
+  --options=dnshH:e:l:k:p:rs:qgv \
-  --options=dnshe:l:k:p:rs:qgv \
   -- "$@" ) \
   || exit 128
 
@@ -258,6 +346,29 @@ do
 			print_usage
 			exit 0
 			;;
+		(-H|--hanoi)
+			HANOI_OPT="$2"
+			MULT="";
+			INT="";
+			case "$2" in
+				(*[0-9]s) MULT=1 ;;
+				(*[0-9]m) MULT=60 ;;
+				(*[0-9]h) MULT=3600 ;;
+				(*[0-9]d) MULT=86400 ;;
+				(*[0-9]w) MULT=604800 ;;
+				(*)
+					print_log error "Unrecognized interval $2 for the $1 parameter."
+					exit 139
+					;;
+			esac
+			INT=$(echo $2 | sed 's/.$//')
+			if ! test "$INT" -gt '0' 2>/dev/null
+			then
+				print_log error "The $2 parameter must be a positive integer."
+			fi
+			opt_hanoi=$(($INT * $MULT))
+			shift 2
+			;;
 		(-k|--keep)
 			if ! test "$2" -gt '0' 2>/dev/null
 			then
@@ -322,18 +433,6 @@ do
 			opt_verbose='1'
 			shift 1
 			;;
-		(--pre-snapshot)
-			opt_pre_snapshot="$2"
-			shift 2
-			;;
-		(--post-snapshot)
-			opt_post_snapshot="$2"
-			shift 2
-			;;
-		(--destroy-only)
-			opt_do_snapshots=''
-			shift 1
-			;;
 		(--)
 			shift 1
 			break
@@ -360,6 +459,11 @@ then
 	exit 134
 fi
 
+if test -n "$opt_hanoi" -a -z "$opt_label"
+then
+	opt_label=hanoi
+fi
+
 # These are the only times that `zpool status` or `zfs list` are invoked, so
 # this program for Linux has a much better runtime complexity than the similar
 # Solaris implementation.
@@ -524,42 +628,30 @@ do
 	TARGETS_RECURSIVE="${TARGETS_RECURSIVE:+$TARGETS_RECURSIVE	}$ii" # nb: \t
 done
 
-# Linux lacks SMF and the notion of an FMRI event, but always set this property
-# because the SUNW program does. The dash character is the default.
-SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'"
-
 # ISO style date; fifteen characters: YYYY-MM-DD-HHMM
 # On Solaris %H%M expands to 12h34.
 DATE=$(date --utc +%F-%H%M)
 
+if test -n "$opt_hanoi" -a "$opt_event" = "-"
+then
+	opt_event=hanoi-$HANOI_OPT-level-$(compute_hanoi_level $DATE)
+fi
+
+# Linux lacks SMF and the notion of an FMRI event, but always set this property
+# because the SUNW program does. The dash character is the default.
+SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'"
+
 # The snapshot name after the @ symbol.
 SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label}-$DATE"
 
 # The expression for matching old snapshots.  -YYYY-MM-DD-HHMM
 SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????"
 
-if [ -n "$opt_do_snapshots" ]
+test -n "$TARGETS_REGULAR" \
-then
+  && print_log info "Doing regular snapshots of $TARGETS_REGULAR"
-	test -n "$TARGETS_REGULAR" \
-	  && print_log info "Doing regular snapshots of $TARGETS_REGULAR"
 
-	test -n "$TARGETS_RECURSIVE" \
+test -n "$TARGETS_RECURSIVE" \
-	  && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
+  && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
-
-	if test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
-	then
-		print_log info "Destroying all but the newest $opt_keep snapshots of each dataset."
-	fi
-elif test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
-then
-	test -n "$TARGETS_REGULAR" \
-	  && print_log info "Destroying all but the newest $opt_keep snapshots of $TARGETS_REGULAR"
-
-	test -n "$TARGETS_RECURSIVE" \
-	  && print_log info "Recursively destroying all but the newest $opt_keep snapshots of $TARGETS_RECURSIVE"
-else
-	print_log notice "Only destroying snapshots, but count of snapshots to preserve not given. Nothing to do."
-fi
 
 test -n "$opt_dry_run" \
   && print_log info "Doing a dry run. Not running these commands..."