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

Fix SNAPNAME to contain the DATE if label is empty

Makefile

@@ -11,5 +11,7 @@ install:
 	install etc/zfs-auto-snapshot.cron.daily    $(DESTDIR)$(PREFIX)/etc/cron.daily/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)$(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
 	install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot

src/zfs-auto-snapshot.8

@@ -0,0 +1,70 @@
+.TH ZFS-AUTO-SNAPSHOT "8" "June 16, 2013" "zfs-auto-snapshot.sh" "System Administration Commands"
+.SH NAME
+zfs-auto-snapshot \- take regular ZFS snapshots
+.SH SYNOPSIS
+.B zfs-auto-snapshot
+[\fIoptions\fR] [\fI-l label\fR] \fI<'//' | name \fR[\fIname\fR...]\fI>\fR
+.SH DESCRIPTION
+.B zfs-auto-snapshot
+automatically creates, rotates, and destroys snapshots for all your
+ZFS datasets, and is compatible with both zfsonlinux and zfs-fuse.
+.SH OPTIONS
+.TP
+\fB\-\-default\-exclude\fR
+By default \fBzfs-auto-snapshot\fR will snapshot all datasets except
+for those in which the user-property \fBcom.sun:auto-snapshot\fR is
+set to \fBfalse\fR.  This option reverses the behavior and requires
+\fBcom.sun:auto-snapshot\fR to be set to \fBtrue\fR.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Print debugging messages.
+.TP
+\fB\-e\fR, \fB\-\-event\fR=\fIEVENT\fR
+Set the com.sun:auto\-snapshot\-desc property to EVENT.
+.TP
+\fB\-\-fast\fR
+Use a faster zfs list invocation.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Print actions without actually doing anything.
+.TP
+\fB\-s\fR, \fB\-\-skip\-scrub\fR
+Do not snapshot filesystems in scrubbing pools.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the usage message.
+.TP
+\fB\-k\fR, \fB\-\-keep\fR=\fINUM\fR
+Keep NUM recent snapshots and destroy older snapshots.
+.TP
+\fB\-l\fR, \fB\-\-label\fR=\fILAB\fR
+LAB is usually 'hourly', 'daily', or 'monthly'.
+.TP
+\fB\-p\fR, \fB\-\-prefix\fR=\fIPRE\fR
+PRE is 'zfs\-auto\-snap' by default.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress warnings and notices at the console.
+.TP
+\fB\-\-send\-full\fR=\fIF\fR
+Send zfs full backup. Unimplemented.
+.TP
+\fB\-\-send\-incr\fR=\fIF\fR
+Send zfs incremental backup. Unimplemented.
+.TP
+\fB\-\-sep\fR=\fICHAR\fR
+Use CHAR to separate date stamps in snapshot names.
+.TP
+\fB\-g\fR, \fB\-\-syslog\fR
+Write messages into the system log.
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+Snapshot named filesystem and all descendants.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Print info messages.
+.TP
+name
+Filesystem and volume names, or '//' for all ZFS datasets.
+.SH SEE ALSO
+.BR zfs (8)

src/zfs-auto-snapshot.sh

@@ -29,6 +29,7 @@ opt_backup_incremental=''
 opt_default_exclude=''
 opt_dry_run=''
 opt_event='-'
+opt_fast_zfs_list=''
 opt_keep=''
 opt_label=''
 opt_prefix='zfs-auto-snap'
@@ -54,9 +55,14 @@ print_usage ()
   --default-exclude  Exclude datasets if com.sun:auto-snapshot is unset.
   -d, --debug        Print debugging messages.
   -e, --event=EVENT  Set the com.sun:auto-snapshot-desc property to EVENT.
+      --fast         Use a faster zfs list invocation.
   -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.
@@ -138,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"
@@ -145,12 +268,9 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 	local NAME="$3"
 	local GLOB="$4"
 	local TARGETS="$5"
-	local KEEP=''
 
-	# global DESTRUCTION_COUNT
 	# global SNAPSHOT_COUNT
 	# global WARNING_COUNT
-	# global SNAPSHOTS_OLD
 
 	for ii in $TARGETS
 	do
@@ -162,29 +282,13 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 			continue
 		fi 
 
-		# Retain at most $opt_keep number of old snapshots of this filesystem,
-		# including the one that was just recently created.
-		test -z "$opt_keep" && continue
-		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#$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
+		if test -z "$opt_hanoi"
+		then
+			test -z "$opt_keep" && continue
+			do_rotate "$FLAGS" "$GLOB" "$ii"
+		else
+			do_hanoi  "$FLAGS" "$GLOB" "$ii"
+		fi
 	done
 }
 
@@ -193,10 +297,10 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 # {
 
 GETOPT=$(getopt \
-  --longoptions=default-exclude,dry-run,skip-scrub,recursive \
-  --longoptions=event:,keep:,label:,prefix:,sep: \
+  --longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \
+  --longoptions=event:,hanoi:,keep:,label:,prefix:,sep: \
   --longoptions=debug,help,quiet,syslog,verbose \
-  --options=dnshe:l:k:p:rs:qgv \
+  --options=dnshH:e:l:k:p:rs:qgv \
   -- "$@" ) \
   || exit 128
 
@@ -226,6 +330,10 @@ do
 			fi
 			shift 2
 			;;
+		(--fast)
+			opt_fast_zfs_list='1'
+			shift 1
+			;;
 		(-n|--dry-run)
 			opt_dry_run='1'
 			shift 1
@@ -238,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
@@ -328,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.
@@ -339,9 +475,14 @@ ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
   -o name,com.sun:auto-snapshot,com.sun:auto-snapshot:"$opt_label") \
   || { print_log error "zfs list $?: $ZFS_LIST"; exit 136; }
 
-SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
-  || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
-
+if [ -n "$opt_fast_zfs_list" ]
+then
+	SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name|grep $opt_prefix |awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' |sort -r -k1,1 -k2,2|awk '{ print substr( $0, 17, length($0) )}') \
+	  || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
+else
+	SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
+	  || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
+fi
 
 # Verify that each argument is a filesystem or volume.
 for ii in "$@"
@@ -487,16 +628,21 @@ do
 	TARGETS_RECURSIVE="${TARGETS_RECURSIVE:+$TARGETS_RECURSIVE	}$ii" # nb: \t
 done
 
+# 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'"
 
-# ISO style date; fifteen characters: YYYY-MM-DD-HHMM
-# On Solaris %H%M expands to 12h34.
-DATE=$(date +%F-%H%M)
-
 # The snapshot name after the @ symbol.
-SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}"
+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}????????????????"