Add zfs-helpers.sh script

Add a script designed to facilitate in-tree development and testing
by installing symlinks on your system which refer to in-tree helper
utilities.  These helper utilities must be installed to in order to
exercise all ZFS functionality.  By using symbolic links and keeping
the scripts in-tree during development they can be easily modified
and those changes tracked.

Signed-off-by: Brian Behlendorf <[email protected]>
Signed-off-by: Olaf Faaland <[email protected]>
Closes #4607

4 files changed, 154 insertions, 1 deletions

diff --git a/scripts/Makefile.am b/scripts/Makefile.am
index c15207a7a..b55600926 100644
--- a/scripts/Makefile.am
+++ b/scripts/Makefile.am
@@ -15,4 +15,5 @@ dist_pkgdata_SCRIPTS = \
 	$(top_srcdir)/scripts/zpios.sh \
 	$(top_srcdir)/scripts/zpios-sanity.sh \
 	$(top_srcdir)/scripts/zpios-survey.sh \
-	$(top_srcdir)/scripts/smb.sh
+	$(top_srcdir)/scripts/smb.sh \
+	$(top_srcdir)/scripts/zfs-helpers.sh
diff --git a/scripts/common.sh.in b/scripts/common.sh.in
index 4ce177e32..27ba88fae 100644
--- a/scripts/common.sh.in
+++ b/scripts/common.sh.in
@@ -37,6 +37,7 @@ bindir=@bindir@
 sbindir=@sbindir@
 udevdir=@udevdir@
 udevruledir=@udevruledir@
+mounthelperdir=@mounthelperdir@
 sysconfdir=@sysconfdir@
 localstatedir=@localstatedir@
 
diff --git a/scripts/zfs-helpers.sh b/scripts/zfs-helpers.sh
new file mode 100755
index 000000000..6e97ce1e2
--- /dev/null
+++ b/scripts/zfs-helpers.sh
@@ -0,0 +1,149 @@
+#!/bin/bash
+#
+# This script is designed to facilitate in-tree development and testing
+# by installing symlinks on your system which refer to in-tree helper
+# utilities.  These helper utilities must be installed to in order to
+# exercise all ZFS functionality.  By using symbolic links and keeping
+# the scripts in-tree during development they can be easily modified
+# and those changes tracked.
+#
+# Use the following configuration option to override the installation
+# paths for these scripts.  The correct path is automatically set for
+# most distributions but you can optionally set it for your environment.
+#
+#   --with-mounthelperdir=DIR  install mount.zfs in dir [/sbin]
+#   --with-udevdir=DIR         install udev helpers [default=check]
+#   --with-udevruledir=DIR     install udev rules [default=UDEVDIR/rules.d]
+#
+
+basedir="$(dirname $0)"
+
+SCRIPT_COMMON=common.sh
+if [ -f "${basedir}/${SCRIPT_COMMON}" ]; then
+. "${basedir}/${SCRIPT_COMMON}"
+else
+echo "Missing helper script ${SCRIPT_COMMON}" && exit 1
+fi
+
+PROG=zfs-helpers.sh
+DRYRUN=
+INSTALL=
+REMOVE=
+VERBOSE=
+
+usage() {
+cat << EOF
+USAGE:
+$0 [dhirv]
+
+DESCRIPTION:
+	Install/remove the ZFS helper utilities.
+
+OPTIONS:
+	-d      Dry run
+	-h      Show this message
+	-i      Install the helper utilties
+	-r      Remove the helper utilities
+	-v      Verbose
+
+$0 -iv
+$0 -r
+
+EOF
+}
+
+while getopts 'hdirv' OPTION; do
+	case $OPTION in
+	h)
+		usage
+		exit 1
+		;;
+	d)
+		DRYRUN=1
+		;;
+	i)
+		INSTALL=1
+		;;
+	r)
+		REMOVE=1
+		;;
+	v)
+		VERBOSE=1
+		;;
+	?)
+		usage
+		exit
+		;;
+	esac
+done
+
+if [ "${INSTALL}" -a "${REMOVE}" ]; then
+	usage
+	die "Specify -i or -r but not both"
+fi
+
+if [ ! "${INSTALL}" -a ! "${REMOVE}" ]; then
+	usage
+	die "Either -i or -r must be specified"
+fi
+
+if [ $(id -u) != 0 ]; then
+	die "Must run as root"
+fi
+
+if [ "$VERBOSE" ]; then
+	echo "--- Configuration ---"
+	echo "udevdir:          $udevdir"
+	echo "udevruledir:      $udevruledir"
+	echo "mounthelperdir:   $mounthelperdir"
+	echo "DRYRUN:           $DRYRUN"
+	echo
+fi
+
+install() {
+	local src=$1
+	local dst=$2
+
+	if [ -h $dst ]; then
+		echo "Symlink exists: $dst"
+	elif [ -e $dst ]; then
+		echo "File exists: $dst"
+	elif [ ! -e $src ]; then
+		echo "Source missing: $src"
+	else
+		msg "ln -s $src $dst"
+
+		if [ ! "$DRYRUN" ]; then
+			ln -s $src $dst
+		fi
+	fi
+}
+
+remove() {
+	local dst=$1
+
+	if [ -h $dst ]; then
+		msg "rm $dst"
+		rm $dst
+	fi
+}
+
+if [ ${INSTALL} ]; then
+	install $CMDDIR/mount_zfs/mount.zfs $mounthelperdir/mount.zfs
+	install $CMDDIR/fsck_zfs/fsck.zfs $mounthelperdir/fsck.zfs
+	install $CMDDIR/zvol_id/zvol_id $udevdir/zvol_id
+	install $CMDDIR/vdev_id/vdev_id $udevdir/vdev_id
+	install $UDEVRULEDIR/60-zvol.rules $udevruledir/60-zvol.rules
+	install $UDEVRULEDIR/69-vdev.rules $udevruledir/69-vdev.rules
+	install $UDEVRULEDIR/90-zfs.rules $udevruledir/90-zfs.rules
+else
+	remove $mounthelperdir/mount.zfs
+	remove $mounthelperdir/fsck.zfs
+	remove $udevdir/zvol_id
+	remove $udevdir/vdev_id
+	remove $udevruledir/60-zvol.rules
+	remove $udevruledir/69-vdev.rules
+	remove $udevruledir/90-zfs.rules
+fi
+
+exit 0
diff --git a/zfs-script-config.sh.in b/zfs-script-config.sh.in
index 37ce37679..5ebaf6977 100644
--- a/zfs-script-config.sh.in
+++ b/zfs-script-config.sh.in
@@ -19,9 +19,11 @@ export ZPIOSPROFILEDIR=${BUILDDIR}/scripts/zpios-profile
 export ETCDIR=${SRCDIR}/etc
 export TESTSDIR=${SRCDIR}/tests
 export RUNFILEDIR=${TESTSDIR}/runfiles
+export UDEVRULEDIR=${BUILDDIR}/udev/rules.d
 
 export ZDB=${CMDDIR}/zdb/zdb
 export ZFS=${CMDDIR}/zfs/zfs
+export ZHACK=${CMDDIR}/zhack/zhack
 export ZINJECT=${CMDDIR}/zinject/zinject
 export ZPOOL=${CMDDIR}/zpool/zpool
 export ZTEST=${CMDDIR}/ztest/ztest