snapinfo -- show snapshot location on UFS file systems

Glanced over by: kan
Review by: ru (snapshot.8)
MFC: TBD

3 files changed, 251 insertions, 0 deletions

diff --git a/usr.sbin/snapinfo/Makefile b/usr.sbin/snapinfo/Makefile
new file mode 100644
index 0000000..c5175f1
--- /dev/null
+++ b/usr.sbin/snapinfo/Makefile
@@ -0,0 +1,10 @@
+# $FreeBSD$
+#
+
+PROG=	snapinfo
+MAN=	snapinfo.8
+
+DPADD=	${LIBUFS}
+LDADD=	-lufs
+
+.include <bsd.prog.mk>               
diff --git a/usr.sbin/snapinfo/snapinfo.8 b/usr.sbin/snapinfo/snapinfo.8
new file mode 100644
index 0000000..424665c
--- /dev/null
+++ b/usr.sbin/snapinfo/snapinfo.8
@@ -0,0 +1,66 @@
+.\"
+.\" Copyright (c) 2005 Mark Santcroos <marks@freebsd.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd July 20, 2005
+.Dt SNAPINFO 8
+.Os
+.Sh NAME
+.Nm snapinfo
+.Nd "show snapshot location on UFS file systems"
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Fl a
+.Nm
+.Op Fl v
+.Ar mountpoint
+.Sh DESCRIPTION
+The
+.Nm
+utility searches and displays the location of snapshots on UFS file systems.
+.Pp
+Currently it works only on mounted file systems.
+It can either search one file system or all of them.
+.Pp
+The following options are available:
+.Bl -tag -width indent
+.It Fl a
+Search for snapshots on all mounted UFS file systems.
+.It Fl v
+Verbose mode.
+.It Ar mountpoint
+Search the file system mounted on this mountpoint.
+.El
+.Sh SEE ALSO
+.Xr ffs 7 ,
+.Xr mksnap_ffs 8
+.Sh HISTORY
+The
+.Nm
+utility first appeared in
+.Fx 7.0 .
+.Sh AUTHORS
+.An Mark Santcroos Aq marks@FreeBSD.org
diff --git a/usr.sbin/snapinfo/snapinfo.c b/usr.sbin/snapinfo/snapinfo.c
new file mode 100644
index 0000000..d0f3f2b
--- /dev/null
+++ b/usr.sbin/snapinfo/snapinfo.c
@@ -0,0 +1,175 @@
+/*-
+ * Copyright (c) 2005 Mark Santcroos <marks@freebsd.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ *
+ */
+
+#include <sys/param.h>
+#include <sys/mount.h>
+
+#include <ufs/ufs/dinode.h>
+#include <ufs/ffs/fs.h>
+
+#include <errno.h>
+#include <ftw.h>
+#include <libufs.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+void	find_inum(char *path);
+void	usage(void);
+int	compare_function(const char *, const struct stat *, int, struct FTW *);
+int	find_snapshot(char *path);
+
+int verbose;
+int cont_search;
+uint32_t inode;
+
+int
+main(int argc, char **argv)
+{
+	char *path;
+	struct stat st;
+	struct statfs *mntbuf;
+	int all = 0, ch, done = 0, fscount, n;
+
+	while ((ch = getopt(argc, argv, "adv")) != -1) {
+		switch (ch) {
+		case 'a':
+			all++;
+			break;
+		case 'd':
+			/* continue to search when matching inode is found 
+			 * this feature is not documented */
+			cont_search++;
+			break;
+		case 'v':
+			verbose++;
+			break;
+		default:
+			usage();
+		}
+	}
+
+	argc -= optind;
+	argv += optind;
+
+	if ((all == 0 && argc != 1) || (all == 1 && argc > 0))
+		usage();
+
+	if (!all) {
+		path = *argv;
+
+		if (strrchr(path, '/') == NULL ||	/* is absolute path */
+		    (stat(path, &st) == -1) || 		/* is it stat'able */
+		    !(st.st_mode & S_IFDIR))  		/* is it a directory */
+			usage();
+	}
+
+	fscount = getmntinfo(&mntbuf, MNT_WAIT);
+	for (n = 0; n < fscount; n++) {
+		if (!strncmp(mntbuf[n].f_fstypename, "ufs", 3)) {
+			if (all)
+				path = mntbuf[n].f_mntonname;
+			else if (strcmp(path, mntbuf[n].f_mntonname))
+				continue;
+
+			find_snapshot(path);
+			done++;
+		}
+	}
+
+	if (!done)
+		usage();
+
+	return (0);
+}
+
+int
+find_snapshot(char *path)
+{
+	struct uufsd disk;
+	int j, snapcount = 0;
+
+	if (ufs_disk_fillout(&disk, path) == -1)
+		perror("ufs_disk_fillout");
+
+	if (verbose)
+		printf("%s mounted on %s\n", disk.d_name, disk.d_fs.fs_fsmnt);
+
+	for (j = 0; j < FSMAXSNAP; j++) {
+		if (disk.d_fs.fs_snapinum[j]) {
+			inode = disk.d_fs.fs_snapinum[j];
+			find_inum(path);
+			snapcount++;
+		}
+	}
+
+	if (!snapcount && verbose)
+		printf("\tno snapshots found\n");
+				
+	return 0;
+}
+
+int
+compare_function(const char *path, const struct stat *st, int flags,
+struct FTW * ftwv)
+{
+
+	if (flags == FTW_F && st->st_ino == inode) {
+		if (verbose)
+			printf("\tsnapshot ");
+		printf("%s", path);
+		if (verbose)
+			printf(" (inode %d)", st->st_ino);
+		printf("\n");
+		if (!cont_search)
+			return (EEXIST);
+	}
+
+	return (0);
+}
+
+void
+find_inum(char *path)
+{
+	int ret;
+
+	ret = nftw(path, compare_function, 1, FTW_PHYS|FTW_MOUNT);
+	if (ret != EEXIST && ret != 0) {
+		perror("ftw");
+		exit(ret);
+	}
+}
+
+void
+usage(void)
+{
+
+	printf("usage: snapinfo [-v] -a\n");
+	printf("       snapinfo [-v] mountpoint\n");
+	exit(1);
+}