Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Repository creation.

  • Loading branch information...
commit 875b55c96771ec6825fea38b1a436d4de7d9182b 0 parents
@dajhorn dajhorn authored
339 COPYING
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
7 Makefile
@@ -0,0 +1,7 @@
+all:
+
+install:
+ install -d $(DESTDIR)$(PREFIX)/etc/cron.d
+ install etc/zfs-auto-snapshot.cron $(DESTDIR)$(PREFIX)/etc/cron.d/zfs-auto-snapshot
+ install -d $(DESTDIR)$(PREFIX)/sbin
+ install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
4 README
@@ -0,0 +1,4 @@
+An alternative implementation of the zfs-auto-snapshot service for Linux.
+
+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.
8 etc/zfs-auto-snapshot.cron
@@ -0,0 +1,8 @@
+PATH="/usr/bin:/bin:/usr/sbin:/sbin"
+OPTIONS="--quiet --syslog"
+
+* */4 * * * root zfs-auto-snapshot $OPTIONS --label=frequent --keep=4 //
+@hourly root zfs-auto-snapshot $OPTIONS --label=hourly --keep=24 //
+@daily root zfs-auto-snapshot $OPTIONS --label=daily --keep=31 //
+@weekly root zfs-auto-snapshot $OPTIONS --label=weekly --keep=4 //
+@monthly root zfs-auto-snapshot $OPTIONS --label=monthly --keep=12 //
511 src/zfs-auto-snapshot.sh
@@ -0,0 +1,511 @@
+#!/bin/sh
+
+# zfs-auto-snapshot for Linux
+# Automatically create, rotate, and destroy periodic ZFS snapshots.
+# Copyright 2011 Darik Horn <dajhorn@vanadac.com>
+#
+# 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 (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the 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., 59 Temple
+# Place, Suite 330, Boston, MA 02111-1307 USA
+#
+
+# Set the field separator to a literal tab and newline.
+IFS="
+"
+
+# Set default program options.
+opt_backup_full=''
+opt_backup_incremental=''
+opt_default_exclude=''
+opt_dry_run=''
+opt_keep=''
+opt_label=''
+opt_prefix='zfs-auto-snap'
+opt_recursive=''
+opt_sep='_'
+opt_setauto=''
+opt_syslog=''
+opt_skip_scrub=''
+opt_verbose=''
+
+
+print_usage ()
+{
+ echo "Usage: $0 [options] [-l label] <'//' | name [name...]>
+ --default-exclude Exclude objects if com.sun:auto-snapshot is unset.
+ -d, --debug Print debugging messages.
+ -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.
+ -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.
+ -q, --quiet Suppress warnings and notices at the console.
+ --send-full=F Send zfs full backup. Unimplemented.
+ --send-incr=F Send zfs incremental backup. Unimplemented.
+ --sep=CHAR Use CHAR to separate date stamps in snapshot names.
+ -g, --syslog Write messages into the system log.
+ -r, --recursive Snapshot named filesystem and all descendants.
+ -v, --verbose Print info messages.
+ name Filesystem and volume names, or '//' for all ZFS objects.
+"
+}
+
+
+print_log () # level, message, ...
+{
+ LEVEL=$1
+ shift 1
+
+ case $LEVEL in
+ (eme*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.emerge $*
+ echo Emergency: $* 1>&2
+ ;;
+ (ale*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.alert $*
+ echo Alert: $* 1>&2
+ ;;
+ (cri*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.crit $*
+ echo Critical: $* 1>&2
+ ;;
+ (err*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.err $*
+ echo Error: $* 1>&2
+ ;;
+ (war*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.warning $*
+ test -z "$opt_quiet" && echo Warning: $* 1>&2
+ ;;
+ (not*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.notice $*
+ test -z "$opt_quiet" && echo $*
+ ;;
+ (inf*)
+ # test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.info $*
+ test -n "$opt_verbose" && echo $*
+ ;;
+ (deb*)
+ # test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.debug $*
+ test -n "$opt_debug" && echo Debug: $*
+ ;;
+ (*)
+ test -n "$opt_syslog" && logger -t "$opt_prefix" $*
+ echo $* 1>&2
+ ;;
+ esac
+}
+
+
+do_run ()
+{
+ if [ -n "$opt_dry_run" ]
+ then
+ echo $*
+ RC="$?"
+ else
+ eval $*
+ RC="$?"
+ if [ "$RC" -eq 0 ]
+ then
+ print_log debug "$*"
+ else
+ print_log warning "$* returned $RC"
+ fi
+ fi
+ return "$RC"
+}
+
+# main ()
+# {
+
+DATE=$(date +%F-%H%M)
+
+GETOPT=$(getopt \
+ --longoptions=default-exclude,dry-run,skip-scrub,recursive \
+ --longoptions=keep:,label:,prefix:,sep: \
+ --longoptions=debug,help,quiet,syslog,verbose \
+ --options=dnshl:k:rs:gv \
+ -- "$@" ) \
+ || exit 1
+
+eval set -- "$GETOPT"
+
+while [ "$#" -gt 0 ]
+do
+ case "$1" in
+ (-d|--debug)
+ opt_debug=1
+ opt_quiet=''
+ opt_verbose=1
+ shift 1
+ ;;
+ (--default-exclude)
+ opt_default_exclude='1'
+ shift 1
+ ;;
+ (-n|--dry-run)
+ opt_dry_run='1'
+ shift 1
+ ;;
+ (-s|--skip-scrub)
+ opt_skip_scrub=1
+ shift 1
+ ;;
+ (-h|--help)
+ print_usage
+ exit 0
+ ;;
+ (-k|--keep)
+ if ! test "$2" -gt 0 2>/dev/null
+ then
+ print_log error "The $1 parameter must be a positive integer."
+ exit 2
+ fi
+ opt_keep="$2"
+ shift 2
+ ;;
+ (-l|--label)
+ opt_label="$2"
+ shift 2
+ ;;
+ (-p|--prefix)
+ # @TODO: Parameter validation. See --sep below for the regex.
+ opt_prefix="$2"
+ ;;
+ (-q|--quiet)
+ opt_debug=''
+ opt_quiet='1'
+ opt_verbose=''
+ shift 1
+ ;;
+ (-r|--recursive)
+ opt_recursive=1
+ shift 1
+ ;;
+ (--sep)
+ case "$2" in
+ ([[:alnum:]_-.:\ ])
+ :
+ ;;
+ ('')
+ print_log error "The $1 parameter must be non-empty."
+ exit 3
+ ;;
+ (*)
+ print_log error "The $1 parameter must be one alphanumeric character."
+ exit 4
+ ;;
+ esac
+ opt_sep="$2"
+ shift 2
+ ;;
+ (-g|--syslog)
+ opt_syslog=1
+ shift 1
+ ;;
+ (-v|--verbose)
+ opt_quiet=''
+ opt_verbose=1
+ shift 1
+ ;;
+ (--)
+ shift 1
+ break
+ ;;
+ esac
+done
+
+if [ "$#" -eq 0 ]
+then
+ print_log error "The filesystem argument list is empty."
+ exit 5
+fi
+
+# Count the number of times '//' appears on the command line.
+SLASHIES='0'
+for ii in "$@"
+do
+ test "$ii" = '//' && SLASHIES=$(( $SLASHIES + 1 ))
+done
+
+if [ "$#" -gt 1 -a "$SLASHIES" -gt 0 ]
+then
+ print_log error "The // must be the only argument if it is given."
+ exit 6
+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.
+
+ZPOOL_STATUS=$(env LC_ALL=C zpool status 2>&1 ) \
+ || { print_log error "zpool status $?: $ZPOOL_STATUS"; exit 7; }
+
+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 8; }
+
+SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
+ || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 9; }
+
+
+# Verify that each argument is a filesystem or volume.
+for ii in "$@"
+do
+ test "$ii" = '//' && continue 1
+ while read NAME PROPERTIES
+ do
+ test "$ii" = "$NAME" && continue 2
+ done <<-HERE
+ $ZFS_LIST
+ HERE
+ print_log error "$ii is not a ZFS filesystem or volume."
+ exit 10
+done
+
+# Get a list of pools that are being scrubbed.
+ZPOOLS_SCRUBBING=$(echo "$ZFS_STATUS" | awk -F ': ' \
+ '$1 ~ /^ *pool$/ { pool = $2 } ; \
+ $1 ~ /^ *scan$/ && $2 ~ /scrub in progress/ { print pool }' \
+ | sort )
+
+# Get a list of pools that cannot do a snapshot.
+ZPOOLS_NOTREADY=$(echo "$ZFS_STATUS" | awk -F ': ' \
+ '$1 ~ /^ *pool$/ { pool = $2 } ; \
+ $1 ~ /^ *state$/ && $2 !~ /ONLINE|DEGRADED/ { print pool } ' \
+ | sort)
+
+# Get a list of objects for which snapshots are explicitly disabled.
+NOAUTO=$(echo "$ZFS_LIST" | awk -F '\t' \
+ 'tolower($2) ~ /false/ || tolower($3) ~ /false/ {print $1}')
+
+# If the --default-exclude flag is set, then exclude all objects that lack
+# an explicit com.sun:auto-snapshot* property. Otherwise, include them.
+if [ -n "$opt_default_exclude" ]
+then
+ # Get a list of objects for which snapshots are explicitly enabled.
+ CANDIDATES=$(echo "$ZFS_LIST" | awk -F '\t' \
+ 'tolower($2) ~ /true/ || tolower($3) ~ /true/ {print $1}')
+else
+ # Invert the NOAUTO list.
+ CANDIDATES=$(echo "$ZFS_LIST" | awk -F '\t' \
+ 'tolower($2) !~ /false/ && tolower($3) !~ /false/ {print $1}')
+fi
+
+# Initialize the list of objects that will get a recursive snapshot.
+TARGETS_RECURSIVE=''
+
+# Initialize the list of objects that will get a non-recursive snapshot.
+TARGETS_REGULAR=''
+
+for ii in $CANDIDATES
+do
+ # Qualify object names so variable globbing works properly.
+ # Suppose ii=tanker/foo and jj=tank sometime during the loop.
+ # Just testing "$ii" != ${ii#$jj} would incorrectly match.
+ iii="$ii/"
+
+ # Exclude objects that are not named on the command line.
+ IN_ARGS='0'
+ for jj in "$@"
+ do
+ if [ "$jj" = '//' -o "$jj" = "$ii" ]
+ then
+ IN_ARGS=$(( $IN_ARGS + 1 ))
+ fi
+ done
+ if [ "$IN_ARGS" -eq '0' ]
+ then
+ continue
+ fi
+
+ # Exclude objects in pools that cannot do a snapshot.
+ for jj in $ZPOOLS_NOTREADY
+ do
+ # Ibid regarding iii.
+ jjj="$jj/"
+
+ # Check whether the pool name is a prefix of the object name.
+ if [ "$iii" != "${iii#$jjj}" ]
+ then
+ print_log info "Excluding $ii because pool $jj is not ready."
+ continue 2
+ fi
+ done
+
+ # Exclude objects in scrubbing pools if the --skip-scrub flag is set.
+ test -z "$opt_skip_scrub" && for jj in $ZPOOLS_SCRUBBING
+ do
+ # Ibid regarding iii.
+ jjj="$jj/"
+
+ # Check whether the pool name is a prefix of the object name.
+ if [ "$iii" != "${iii#$jjj}" ]
+ then
+ print_log info "Excluding $ii because pool $jj is scrubbing."
+ continue 2
+ fi
+ done
+
+ for jj in $NOAUTO
+ do
+ # Ibid regarding iii.
+ jjj="$jj/"
+
+ # The --recusive switch only matters for non-wild arguments.
+ if [ -z "$opt_recursive" -a "$1" != '//' ]
+ then
+ # Snapshot this object non-recursively.
+ print_log debug "Including $ii for regular snapshot."
+ TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
+ continue 2
+ # Check whether the candidate name is a prefix of any excluded object name.
+ elif [ "$jjj" != "${jjj#$iii}" ]
+ then
+ # Snapshot this object non-recursively.
+ print_log debug "Including $ii for regular snapshot."
+ TARGETS_REGULAR="${TARGETS_REGULAR:+$TARGETS_REGULAR }$ii" # nb: \t
+ continue 2
+ fi
+ done
+
+ for jj in $TARGETS_RECURSIVE
+ do
+ # Ibid regarding iii.
+ jjj="$jj/"
+
+ # Check whether any included object is a prefix of the candidate name.
+ if [ "$iii" != "${iii#$jjj}" ]
+ then
+ print_log debug "Excluding $ii because $jj includes it recursively."
+ continue 2
+ fi
+ done
+
+ # Append this candidate to the recursive snapshot list because it:
+ #
+ # * Does not have an exclusionary property.
+ # * Is in a pool that can currently do snapshots.
+ # * Does not have an excluded descendent filesystem.
+ # * Is not the descendant of an already included filesystem.
+ #
+ print_log debug "Including $ii for recursive snapshot."
+ TARGETS_RECURSIVE="${TARGETS_RECURSIVE:+$TARGETS_RECURSIVE }$ii" # nb: \t
+done
+
+# Summary statistics.
+DESTRUCTION_COUNT='0'
+SNAPSHOT_COUNT='0'
+WARNING_COUNT='0'
+
+# Linux lacks SMF and the notion of an FMRI event.
+FMRI_EVENT='-'
+
+# Create the snapshot using these arguments.
+SNAPSHOT_PROPERTIES="-o com.sun:auto-snapshot-desc='$FMRI_EVENT'"
+SNAPSHOT_NAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}"
+
+# The expression for old snapshots. -YYYY-MM-DD-HHMM
+SNAPSHOT_MATCH="$opt_prefix${opt_label:+?$opt_label}????????????????"
+
+test -n "$TARGETS_REGULAR" \
+ && print_log info "Doing regular snapshots of $TARGETS_REGULAR"
+
+test -n "$TARGETS_RECURSIVE" \
+ && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
+
+test -n "$opt_dry_run" \
+ && print_log info "Doing a dry run. Not running these commands..."
+
+
+for ii in $TARGETS_REGULAR
+do
+ if do_run "zfs snapshot $SNAPSHOT_PROPERTIES '$ii@$SNAPSHOT_NAME'"
+ then
+ SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT +1 ))
+ else
+ WARNING_COUNT=$(( $WARNING_COUNT +1 ))
+ continue
+ fi
+
+ # Retain at most $opt_keep number of old snapshots of this filesystem,
+ # including the one that was just recently created.
+ if [ -z "$opt_keep" ]
+ then
+ continue
+ fi
+ KEEP="$opt_keep"
+
+ for jj in $SNAPSHOTS_OLD
+ do
+ # Check whether this is an old snapshot of the filesystem.
+ if [ -z "${jj#$ii@$SNAPSHOT_MATCH}" ]
+ then
+ KEEP=$(( $KEEP - 1 ))
+ if [ "$KEEP" -le 0 ]
+ then
+ if do_run "zfs destroy '$jj'"
+ then
+ DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT +1 ))
+ else
+ WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
+ fi
+ fi
+ fi
+ done
+done
+
+for ii in $TARGETS_RECURSIVE
+do
+ if do_run "zfs snapshot $SNAPSHOT_PROPERTIES -r '$ii@$SNAPSHOT_NAME'"
+ then
+ SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT +1 ))
+ else
+ WARNING_COUNT=$(( $WARNING_COUNT +1 ))
+ continue
+ fi
+
+ # Retain at most $opt_keep number of old snapshots of this filesystem,
+ # including the one that was just recently created.
+ if [ -z "$opt_keep" ]
+ then
+ continue
+ fi
+ 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@$SNAPSHOT_MATCH}" ]
+ then
+ KEEP=$(( $KEEP - 1 ))
+ if [ "$KEEP" -le 0 ]
+ then
+ if do_run "zfs destroy -r '$jj'"
+ then
+ DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT +1 ))
+ else
+ WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
+ fi
+ fi
+ fi
+ done
+done
+
+print_log notice "@$SNAPSHOT_NAME, \
+$SNAPSHOT_COUNT created, $DESTRUCTION_COUNT destroyed, $WARNING_COUNT warnings."
+
+# }
Please sign in to comment.
Something went wrong with that request. Please try again.